bc_tiled_plugin

Tiled plugin to edit Bondage Club maps
git clone https://git.neptards.moe/u3shit/bc_tiled_plugin.git
Log | Files | Refs | README | LICENSE

README.md (3909B)

      1 Tiled plugin to edit Bondage Club maps.
      2 
      3 Installation
      4 ============
      5 
      6 Make sure you have [Tiled](https://www.mapeditor.org/) 1.8 or later installed.
      7 
      8 Clone the repo or download the zip and unpack it to the following locations
      9 based on your operating system:
     10 
     11 Platform | Location
     12 ------------ | -------------
     13 Windows | `C:/Users/<USER>/AppData/Local/Tiled/extensions/`
     14 MacOS | `~/Library/Preferences/Tiled/extensions/`
     15 Linux | `~/.config/tiled/extensions/`
     16 
     17 Usage
     18 =====
     19 
     20 After installing this plugin, you should be able to save and load Bonage Club
     21 maps as txt files.
     22 
     23 To create a new map, load `empty.txt` included with your download. Do not use
     24 the New Map option from the menu, a BC map has a lot of requirements, and
     25 setting them up manually is a pain.
     26 
     27 To edit an existing map from BC, use `/mapcopy` command in BC to save the map to
     28 your clipboard, and using some text editor (likely Notepad if you're using
     29 Windows), save it to a `.txt` file.
     30 
     31 To export your map to BC, save your maps as `Bondage Club map (*.txt)`, open the
     32 `.txt` file in a text editor, copy the contents, and paste it after a
     33 `/mappaste` command in BC. See below for tips if you receive an error during
     34 exporting.
     35 
     36 Editing
     37 =======
     38 
     39 I'll refer to the [Tiled manual](https://doc.mapeditor.org/en/stable/) on how to
     40 use the map editor. I'm only going to highlight the gotchas when it comes to
     41 editing BC maps.
     42 
     43 * Do not resize the map. It has to be 40x40, BC doesn't support any other size.
     44 * Similarly, do not mess with the layers or the tilesets. BC only has two layers
     45   and no custom tiles. Also do not attempt to edit the two tilesets that come
     46   with this plugin.
     47 * The `Tiles` layer can only contain tiles from the `Tiles` tileset. Similarly,
     48   the `Objects` layer can only contain tiles from the `Objects` tileset. If you
     49   mess this up, you'll get an error message with the position of the wrong tile.
     50 * In addition, the `Tiles` layer must have no empty tiles. BC by default fills
     51   it up with that wooden tile, you should generally not use the Eraser tool on
     52   this layer.
     53 * Specific objects can be only placed over specific tiles, but tiled or this
     54   plugin doesn't check for it. You can export maps like these without problems,
     55   but upon loading BC will remove the invalid objects. The _Map_ -> _Validate BC
     56   Map_ option tries to check for these errors (but no guarantees).
     57 * Walls are about 1.5 tiles high in BC with some complicated logic on how to
     58   handle adjacent walls. Tiled doesn't simulate this, as such maps will look a
     59   bit different than in BC. I recommend enabling "Show Tile Collision Shapes" in
     60   the View menu to at least have some visual feedback on which tiles are walls,
     61   because without BC's extra handling, walls blend into floor tiles.
     62 
     63 Because of the last two, be sure to test your map in BC to prevent surprises!
     64 
     65 Also, telling gold/bronze keys/locks on doors and silver/admin locks apart can
     66 be really hard in BC's graphics. While this is probably a feature in BC, and
     67 trap rooms love to use this, it can be annoying when editing, so I provide an
     68 alternate tileset where these keys/doors are clearly labeled with a B/S/G/A for
     69 broze/silver/gold/admin-only locks respectively. To use this, take the files in
     70 `tileset_object_visible` folder and copy them to `tileset_objects` (overwriting
     71 the files there) and restarting tiled.
     72 
     73 License
     74 =======
     75 
     76 The source code is licensed under the WTFP Version 2 license. Uses the
     77 third-party lz-string, also licensed under WTFP Version 2. The image assets for
     78 the tilesets come from the Bondage Club, and licensing is a bit unclear in this
     79 case, to say the least.
     80 
     81 This program is free software. It comes without any warranty, to the extent
     82 permitted by applicable law. You can redistribute it and/or modify it under the
     83 terms of the Do What The Fuck You Want To Public License, Version 2, as
     84 published by Sam Hocevar. See http://www.wtfpl.net/ for more details.