You can either contribute tiles directly by following the guide below, or create an issue with the Tiles Request template
If you wish to contribute to tiles, follow the instructions below.
- Fork the repo
- Create a new branch with a name like so
tiles/<tile name>e.g.tiles/vorkath-melee - Add the tiles to the 'entities' folder following the format used in other tiles (look at abyssal sire for an example)
- Commit the changes and push to the repo
- Open a pull request with a description of the changes
- Wait for the pull request to be accepted
To start the project locally using Docker, run:
docker compose up
# or if you want to run in the background
docker compose up -dTo stop the background local dev server, run:
docker compose down
This will run a development server at http://localhost:8080 with hot reloading enabled.
For HTTPS, use Caddy as a reverse proxy:
# install Caddy
brew install caddy # macOS
sudo apt install caddy # Linux
# start the dev server
docker compose up -d # to run it in the background
# or
docker compose up # to run it in the active terminal
# start Caddy
caddy start # to run it in the background
# or
caddy run # run in the active terminal
# access: https://localhost
# restart browser if you see "Not Secure"To stop the background local dev server with HTTPS, run:
docker compose down
caddy stop
To install the dependencies, run:
go mod downloadTo start the project locally for development, run:
go run ./cmd/server/To build the project, run:
go run ./cmd/build/Open http://localhost:8080 with your browser to see the result.
To check that the thumbnail, wiki, source and guide video links in the entities still work, run:
go test ./internal/links/ -count=1To check a single entity, run:
go test ./internal/links/ -count=1 -run 'TestEntityLinks/vorkath'This also runs in CI, and won't block a build.
- Go >= 1.22
./cmd/server/— Starts the application in development mode athttp://localhost:8080../cmd/build/— Creates an optimized production build of your application.
This project is licensed under the MIT License - see the LICENSE.md file for more information.
Made with contrib.rocks.
Thank you to these contributors also, who contributed before the Go rewrite: