Add ggez example #161

PieKing1215 · 2022-02-14T21:09:46Z

Adds a rendering demo for ggez.
Supports multiple layers, multiple tilesets, and parallax.
Also draws basic shape objects.

You can middle mouse + drag to pan around and scroll to zoom.
Right click also toggles a demo animation that makes the tiles move around.

It has pretty good performance because it uses ggez's SpriteBatches for tile rendering. It could be better by caching and reusing the batches but I figured I'd leave that out to simplify a bit.

I made a nicer example map for testing locally but I'll make a separate PR for that I think.
Since the current example map is large and mostly empty, and this centers it in the window at the start, you need to zoom out or pan in order to see it (the other nicer map has a more reasonable size).

(this does not properly hook into ggez's filesystem for loading external tilesets/images as that would still require something like #100 I believe)

This could probably still use a bit more clean up and commenting

related: #134

bjorn · 2022-02-14T21:58:06Z

It did not compile for me:

error: there is no argument named `fps`
  --> examples/ggez/main.rs:83:49
   |
83 |         let text = graphics::Text::new(format!("{fps:.0} fps"));
   |                                                 ^^^^^^^^

error: could not compile `tiled` due to previous error

Also, seems like we need to add libasound2-dev and libudev-dev to the apt install command.

PieKing1215 · 2022-02-14T22:06:24Z

error: there is no argument named fps

I just changed it so it should compile on older rust versions (that feature was only just added in rust 1.58)

aleokdev

I'd appreciate if you add an example description as doc comments to the main file (like in the SFML example). Apart from that I've got two comments:

examples/ggez/main.rs

examples/ggez/map.rs

bjorn

Great and smooth running example! It showed over 5000 FPS for me on my aging GTX 1060, and over 7000 FPS when caching the layer_batches. Nice animation too! I've just left some minor comments.

examples/ggez/main.rs

examples/ggez/map.rs

bjorn · 2022-02-15T15:23:18Z

examples/ggez/map.rs

+            tiled::ObjectShape::Rect { width, height } => {
+                let bounds = graphics::Rect::new(object.x, object.y, *width, *height);
+                let shape =
+                    graphics::Mesh::new_rectangle(ctx, graphics::DrawMode::stroke(2.0), bounds, graphics::Color::CYAN)?;


Note that there is also Object::get_tile, which would be nice to support as well. Of course then the object needs to be accessed through ObjectLayer::get_object instead of iterating ObjectLayerData::objects directly.

Since this might be a bit of a cludge, we could wait with supporting that until #158 is resolved.

examples/ggez/map.rs

examples/ggez/main.rs

examples/ggez/map.rs

Co-authored-by: Alejandro Perea <alexpro820@gmail.com>

Co-authored-by: Thorbjørn Lindeijer <bjorn@lindeijer.nl>

PieKing1215 · 2022-02-26T07:39:59Z

Cleaned up some of the easy stuff, still some organization and structural things left to do, and I still need to merge master into here again

aleokdev · 2022-03-02T10:31:20Z

examples/ggez/map.rs

+        for layer in &layer_batches {
+            // for each tileset in the layer
+            for batch in layer {
+                graphics::draw(ctx, batch, draw_param)?;
+            }
+        }


Could be flattened to a single vector if layer batches are sequentially placed by index

And fixed compile due to API changes.

bjorn · 2022-03-28T11:30:47Z

I've merged master and fixed the compile, and also adjusted main.rs to use the new Loader class. However, for me this example is currently just displaying a magic pink window. Any idea why I'm no longer seeing the map?

@PieKing1215 Do you think you could find some time to finalize this example? I think it'd be really nice to have this merged, and it would eventually also be able to demonstrate the VFS support that has been merged for 0.11 (#199).

bjorn · 2022-03-28T11:32:22Z

@aleokdev It appears the clippy check needs also the dependencies installed. Maybe it would make sense to merge it with the build check?

aleokdev · 2022-03-28T11:34:22Z

The CI deps can be added in this PR as they're needed by this example. Is that what you're referring to? I'm not sure if I understood you.

bjorn · 2022-03-28T11:35:59Z

The CI deps can be added in this PR as they're needed by this example. Is that what you're referring to? I'm not sure if I understood you.

I just mean that it's somewhat annoying if we need to install the dependencies in two places in the workflow, just because the build and clippy checks happen on separate virtual machines. It might be better to just perform those checks at two separate steps on the same machine.

aleokdev · 2022-03-28T11:44:41Z

Oh, sure, that makes sense. However, I'd like for them to be treated as separate checks so that we can see at a glance what's wrong. Is that possible?

bjorn · 2022-03-28T12:56:11Z

Oh, sure, that makes sense. However, I'd like for them to be treated as separate checks so that we can see at a glance what's wrong. Is that possible?

I agree that would be nice, but I have no idea whether this is possible. Maybe it can be done with this github-checks action.

PieKing1215 · 2022-03-28T19:18:56Z

@PieKing1215 Do you think you could find some time to finalize this example? I think it'd be really nice to have this merged, and it would eventually also be able to demonstrate the VFS support that has been merged for 0.11 (#199).

Yeah sorry about the lack of progress on this, I've been particularly busy recently but I should be able to dedicate some time to adding the rest of the suggested things.
(Thanks for merging master btw)

However, for me this example is currently just displaying a magic pink window. Any idea why I'm no longer seeing the map?

Did you try zooming out? It centers the map at the start but the test map's size is way too big and mostly empty so you can't see anything without zooming/panning (should probably fix this)

bjorn · 2022-03-28T21:08:20Z

Did you try zooming out? It centers the map at the start but the test map's size is way too big and mostly empty so you can't see anything without zooming/panning (should probably fix this)

Heh, it had been a while since I had run this example, and I had just forgotten about the need to zoom out, whoops! But yes, that should definitely be fixed.

Cache gets invalidated when panning/zooming or every frame while animating The performance improvement would be more noticeable if there were more layers & more tilesets per layer

PieKing1215 · 2022-04-02T21:40:12Z

The main things I can think of that are unsupported in this right now are:

Tile objects
Infinite maps
ImageLayer
GroupLayer

I plan on doing tile objects already, but I'm not sure about the other stuff. Idk how all-encompassing we want this example to be.
Also should I do VFS in this PR (and change base branch to 0.11) or leave that for the future?

bjorn · 2022-04-03T09:45:51Z

I plan on doing tile objects already, but I'm not sure about the other stuff. Idk how all-encompassing we want this example to be.

I think tile objects would be good to cover, but the other stuff is not so important.

Also should I do VFS in this PR (and change base branch to 0.11) or leave that for the future?

I would suggest to target 0.10 first and update the example after merging it to 0.11, unless the lack of using VFS is really setting a bad example and we'd rather want to wait till 0.11 to show how to use this crate with ggez at all.

aleokdev · 2022-04-03T10:34:05Z

I'd target 0.11 to be honest, VFS is a huge deal with ggez (Plus 0.11's interface is basically finished at this point)

aleokdev · 2022-04-12T11:49:35Z

Should we base this on 0.11 then?

bjorn · 2022-04-12T14:23:13Z

@aleokdev It's fine with me too.

aleokdev · 2022-04-12T14:30:05Z

@PieKing1215 I'm basing this onto 0.11 then; You'll be able to use custom loaders now. My platformer template repo has an example of their usage:

// Need to do newtype to implement ResourceReader for ggez's filesystem
// FIXME: This would greatly improve with separated subcontexts (ggez 0.8.0)
pub struct FsContext<'ctx>(pub &'ctx mut ggez::Context);

impl tiled::ResourceReader for FsContext<'_> {
    type Resource = filesystem::File;

    type Error = GameError;

    fn read_from(
        &mut self,
        path: &std::path::Path,
    ) -> std::result::Result<Self::Resource, Self::Error> {
        filesystem::open(&self.0, path)
    }
}

Then you can simply

let mut loader = tiled::Loader::with_cache_and_reader(
     tiled::DefaultResourceCache::new(),
     FsContext(ctx),
);

And not worry about paths anymore. When tiled needs to load any supplementary data, it'll use ggez's filesystem to do so.

PieKing1215 · 2022-04-12T15:00:10Z

Cool, I'll take a look later then.

thread 'main' panicked at '`"pkg-config" "--libs" "--cflags" "alsa"` did not exit successfully: exit status: 1 error: could not find system library 'alsa' required by the 'alsa-sys' crate

"Package libudev was not found in the pkg-config search path."

bjorn

The map could be nicer, but I think the example is good to go now.

Btw, even if we have all done some edits in this PR and it has some history, I would still suggest we squash it all into a single commit, since the various changes are not really relevant on their own.

* Rendering example for ggez * Update ggez example * Refactoring for ggez example * Re-add example entry I accidently removed * Add note about caching layer_batches in ggez ex * Update contributors list * Change format string in ggez example to work on older rust versions * Add libasound2-dev and libudev-dev to rust workflow apt install * ggez: use CARGO_MANIFEST_DIR Co-authored-by: Alejandro Perea <alexpro820@gmail.com> * ggez: destructure some variables Co-authored-by: Thorbjørn Lindeijer <bjorn@lindeijer.nl> * ggez: more destructuring * ggez: make left mouse also drag * ggez: reduce time_since_start calls, make get_tile_rect return Rect * Use the Loader * Refactor some minor things * Don't center the map by default * Add batch caching to ggez example Cache gets invalidated when panning/zooming or every frame while animating The performance improvement would be more noticeable if there were more layers & more tilesets per layer * Cargo fmt * Polish * Fixed 'bounds' function and removed unused import * Apparently clippy check now needs alsa thread 'main' panicked at '`"pkg-config" "--libs" "--cflags" "alsa"` did not exit successfully: exit status: 1 error: could not find system library 'alsa' required by the 'alsa-sys' crate * Also install udev dependency "Package libudev was not found in the pkg-config search path." Co-authored-by: Alejandro Perea <alexpro820@gmail.com> Co-authored-by: Thorbjørn Lindeijer <bjorn@lindeijer.nl> Co-authored-by: aleokdev <aleok.inf@gmail.com>

PieKing1215 added 7 commits February 14, 2022 13:05

Rendering example for ggez

3687c89

Merge remote-tracking branch 'upstream/master' into ggez-example

c6d2631

Update ggez example

771aa82

Refactoring for ggez example

04ee21c

Re-add example entry I accidently removed

f25b5e3

Add note about caching layer_batches in ggez ex

aa290bf

Update contributors list

04161c5

Change format string in ggez example to work on older rust versions

427c927

Add libasound2-dev and libudev-dev to rust workflow apt install

81207f0

aleokdev reviewed Feb 15, 2022

View reviewed changes

examples/ggez/main.rs Outdated Show resolved Hide resolved

examples/ggez/map.rs Outdated Show resolved Hide resolved

bjorn reviewed Feb 15, 2022

View reviewed changes

aleokdev reviewed Feb 16, 2022

View reviewed changes

examples/ggez/map.rs Outdated Show resolved Hide resolved

aleokdev reviewed Feb 16, 2022

View reviewed changes

examples/ggez/map.rs Outdated Show resolved Hide resolved

aleokdev reviewed Feb 16, 2022

View reviewed changes

examples/ggez/main.rs Outdated Show resolved Hide resolved

aleokdev reviewed Feb 20, 2022

View reviewed changes

examples/ggez/map.rs Outdated Show resolved Hide resolved

aleokdev added the tests label Feb 23, 2022

PieKing1215 and others added 5 commits February 26, 2022 02:17

ggez: use CARGO_MANIFEST_DIR

877ed10

Co-authored-by: Alejandro Perea <alexpro820@gmail.com>

ggez: destructure some variables

7d7de5f

Co-authored-by: Thorbjørn Lindeijer <bjorn@lindeijer.nl>

ggez: more destructuring

5dc0589

ggez: make left mouse also drag

8ca1af4

ggez: reduce time_since_start calls, make get_tile_rect return Rect

1e6ea24

aleokdev reviewed Mar 2, 2022

View reviewed changes

bjorn added 2 commits March 28, 2022 13:27

Merge branch 'master' into ggez-example

442c601

And fixed compile due to API changes.

Use the Loader

775c192

PieKing1215 added 4 commits April 2, 2022 16:28

Refactor some minor things

aaa95c2

Don't center the map by default

8b58286

Add batch caching to ggez example

a550e4d

Cache gets invalidated when panning/zooming or every frame while animating The performance improvement would be more noticeable if there were more layers & more tilesets per layer

Cargo fmt

55ab4fa

aleokdev changed the base branch from master to 0.11 April 12, 2022 14:26

aleokdev and others added 5 commits May 10, 2022 10:24

Merge remote-tracking branch 'upstream/next' into ggez-example

790bfbc

Polish

a2c4c8b

Fixed 'bounds' function and removed unused import

a758753

Apparently clippy check now needs alsa

5603049

thread 'main' panicked at '`"pkg-config" "--libs" "--cflags" "alsa"` did not exit successfully: exit status: 1 error: could not find system library 'alsa' required by the 'alsa-sys' crate

Also install udev dependency

923215b

"Package libudev was not found in the pkg-config search path."

bjorn approved these changes May 10, 2022

View reviewed changes

aleokdev merged commit ea91808 into mapeditor:next May 10, 2022

bjorn mentioned this pull request May 19, 2022

Merge current into next #222

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ggez example #161

Add ggez example #161

PieKing1215 commented Feb 14, 2022

bjorn commented Feb 14, 2022 •

edited

PieKing1215 commented Feb 14, 2022

aleokdev left a comment

bjorn left a comment

bjorn Feb 15, 2022

PieKing1215 commented Feb 26, 2022

aleokdev Mar 2, 2022

bjorn commented Mar 28, 2022

bjorn commented Mar 28, 2022

aleokdev commented Mar 28, 2022

bjorn commented Mar 28, 2022 •

edited

aleokdev commented Mar 28, 2022 •

edited

bjorn commented Mar 28, 2022

PieKing1215 commented Mar 28, 2022

bjorn commented Mar 28, 2022

PieKing1215 commented Apr 2, 2022

bjorn commented Apr 3, 2022

aleokdev commented Apr 3, 2022 •

edited

aleokdev commented Apr 12, 2022

bjorn commented Apr 12, 2022

aleokdev commented Apr 12, 2022

PieKing1215 commented Apr 12, 2022

bjorn left a comment •

edited

Add ggez example #161

Add ggez example #161

Conversation

PieKing1215 commented Feb 14, 2022

bjorn commented Feb 14, 2022 • edited

PieKing1215 commented Feb 14, 2022

aleokdev left a comment

Choose a reason for hiding this comment

bjorn left a comment

Choose a reason for hiding this comment

bjorn Feb 15, 2022

Choose a reason for hiding this comment

PieKing1215 commented Feb 26, 2022

aleokdev Mar 2, 2022

Choose a reason for hiding this comment

bjorn commented Mar 28, 2022

bjorn commented Mar 28, 2022

aleokdev commented Mar 28, 2022

bjorn commented Mar 28, 2022 • edited

aleokdev commented Mar 28, 2022 • edited

bjorn commented Mar 28, 2022

PieKing1215 commented Mar 28, 2022

bjorn commented Mar 28, 2022

PieKing1215 commented Apr 2, 2022

bjorn commented Apr 3, 2022

aleokdev commented Apr 3, 2022 • edited

aleokdev commented Apr 12, 2022

bjorn commented Apr 12, 2022

aleokdev commented Apr 12, 2022

PieKing1215 commented Apr 12, 2022

bjorn left a comment • edited

Choose a reason for hiding this comment

bjorn commented Feb 14, 2022 •

edited

bjorn commented Mar 28, 2022 •

edited

aleokdev commented Mar 28, 2022 •

edited

aleokdev commented Apr 3, 2022 •

edited

bjorn left a comment •

edited