docs: update

Author: rohrsben

docs/.vitepress/config.mts

@@ -44,7 +44,7 @@ export default defineConfig({
         items: [
           { text: 'PixelInfo', link: '/userdata/pixelinfo' },
           { text: 'ColorInfo', link: '/userdata/colorinfo' },
-          { text: 'Anchor', link: '/userdata/anchor' },
+          { text: 'PlacerInfo', link: '/userdata/placerinfo' },
         ],
       },
       {

docs/configuration/tileset.md

@@ -15,15 +15,18 @@ I recommend defining this in a `tileset.lua` file which is contained in the tile
 - `name` - string
 
 This has to be the same as the tileset's folder
-- `tile_size` - nil, positive number
+- `base_tile_size` - positive number (pixels)
 
-For now, this is automatically inferred and doesn't need to be set. Stay tuned though!
+Informs wavewall of the "default", or 1x, tile size. Tiles are allowed to be integer multiples of this size.
+If you use multiple tile sizes, make sure that everything is actually an integer multiple! Gaps will appear
+in the output image otherwise.
 
 ::: details Example
 ```lua
 tileset = {
     info = {
-        name = "my_tileset"
+        name = "my_tileset",
+        base_tile_size = 100
     }
 }
 ```

docs/userdata/anchor.md docs/userdata/placerinfo.mddocs/userdata/anchor.md renamed to docs/userdata/placerinfo.md

@@ -1,11 +1,12 @@
 ---
-title: Anchor
+title: PlacerInfo
 ---
 # About
-`Anchor` is a table provided to a `placer` function. It has the following fields:
+`PlacerInfo` is a table provided to a `placer` function. It has the following fields:
 
 - `x`: the x coordinate of the anchor
 - `y`: the y coordinate of the anchor
+- `max_scale`: the max integer-multiple size the tile that `placer` returns is allowed to be, as compared to `tileset.info.base_tile_size`
 
 The coordinates are not in pixels; rather, they are in tile lengths. If we imagine an output image that can fit four tiles inside it, the anchors would look like this:
 

src/config/tileset/info.rs

@@ -6,7 +6,7 @@ use mlua::{Table, Value};
 #[derive(Debug)]
 pub struct Info {
     pub name: String,
-    pub tile_size: usize,
+    pub base_tile_size: usize,
 }
 
 pub fn parse(input: Value, loc: &Location) -> Result<Info, AppError> {
@@ -24,11 +24,11 @@ pub fn parse(input: Value, loc: &Location) -> Result<Info, AppError> {
 }
 
 fn parse_table(table: Table, loc: &Location) -> Result<Info, AppError> {
-    opt_simple!(name,      string_necessary, table, loc);
-    opt_simple!(tile_size, uint_necessary,   table, loc);
+    opt_simple!(name,           string_necessary, table, loc);
+    opt_simple!(base_tile_size, uint_necessary,   table, loc);
 
     Ok(Info {
         name,
-        tile_size
+        base_tile_size
     })
 }

src/result/mod.rs

@@ -18,7 +18,6 @@ pub struct ResultAnchors {
     image: Image,
     tile_size: i64,
     anchors: Vec<Anchor>,
-    largest_anchor: Anchor
 }
 
 pub struct ResultTiles {
@@ -57,13 +56,10 @@ impl ResultAnchors {
         info!("created {} anchors", anchors.len());
         debug!(?anchors);
 
-        let largest_anchor = anchors.last().unwrap().clone();
-
         Self {
             image,
             tile_size,
             anchors,
-            largest_anchor
         }
     }
 
@@ -72,7 +68,6 @@ impl ResultAnchors {
             image,
             tile_size,
             anchors,
-            largest_anchor
         } = self;
 
         let mut rng = rand::rng();

src/runtime/mod.rs

@@ -82,7 +82,7 @@ impl Runtime {
             tileset,
         } = source;
 
-        let tile_size = tileset.info.tile_size;
+        let tile_size = tileset.info.base_tile_size;
 
         let recipe_name = match tileset.recipe {
             Some(recipe) => recipe,