https://github.com/tw-tooling/tw-rule-generator

create rules for tile replacement in Teeworlds maps
https://github.com/tw-tooling/tw-rule-generator

teeworlds

Last synced: 3 months ago
JSON representation

create rules for tile replacement in Teeworlds maps

• Host: GitHub
• URL: https://github.com/tw-tooling/tw-rule-generator
• Owner: tw-tooling
• License: mit
• Created: 2023-11-30T13:56:34.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-02T21:50:05.000Z (about 1 year ago)
• Last Synced: 2023-12-03T00:28:36.107Z (about 1 year ago)
• Topics: teeworlds
• Language: HTML
• Homepage: https://tw-tooling.github.io/tw-rule-generator/tw-rule-generator.html
• Size: 33.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Teeworlds Rule Generator

This Teeworlds Rule Generator is a web-based tool designed to create rules for tile replacement in Teeworlds game maps. It offers a simple interface to generate the rules.

URL: https://tw-tooling.github.io/tw-rule-generator/tw-rule-generator.html

## Features

Dynamic Rule Generation: Automatically generates rules based on user input for tile numbers.

Customizable Parameters:

* Rule Name: Assign a unique name to each rule.

* Tileset Name: The name of the tileset. Will be used for naming the downloadable file.

* Base Tile: Select the tile number that will be replaced.

* Border Tile: Choose the tile number for flat surfaces.

* Corner Tile Outer: Specify the tile for outer (convex) corners.

* Corner Tile Inner: Define the tile for inner (concave) corners.

* Corner Tile Inlay: Assign the tile for inner (concave corners, that will be put in the empty space.

Copy to Clipboard: Easily copy the generated rules to the clipboard for use in Teeworlds.

Download: Download the file that can be put into `.../data/editor/automap` to load the rules.

## How to Use

1. Input Parameters: Fill in the form with the desired tile numbers and rule name.

2. Generate Rule: The tool automatically generates the rule script as you input values.

3. Copy/Download Rule: Click the "Copy Rule to Clipboard" or "Download" button to use the rule in your Teeworlds map.

4. Copy the file to `.../data/editor/automap` or paste the code into an existing file.

## Python Version

There is also a [Jupyter notebook](tw-rule-generator-gradio.ipynb) version of the tool that can be run locally. It uses the [Gradio](https://gradio.app/) library to create an interface.

## Acknowledgements

This tool utilizes Bootstrap for styling and JavaScript for its interactive features. It is intended for Teeworlds map creators and enthusiasts looking to enhance their map design process.

### Helpful Rule References

* Forum Post: https://www.teeworlds.com/forum/viewtopic.php?pid=92492

* Forum Post: https://forum.ddnet.org/viewtopic.php?t=2428

* Alternative Windows App with more options: https://github.com/ZonsaC/Teeworlds-Automapper