This repository has been archived on 2023-10-03. You can view files and clone it, but cannot push or open issues or pull requests.
ltt-mapmaker/README.md
2022-02-25 12:07:48 +01:00

14 KiB

banner

Homepage Blog Fleet GitHub DockerHub Discord


Sources, GitHub, GitLab and Mirroring and all that good stuff

Repositories on GitHub are now for issues only. I've set up my own installation of GitLab and moved all my repositories over to Git.Griefed.de. Make sure to check there first for the latest code before opening an issue on GitHub.

For questions, you can always join my Discord server and talk to me there.

This repository is available at:

Docker Pulls Docker Image Size (latest by date)

GitHub release (latest by date including pre-releases) GitHub

GitHub Repo stars GitHub forks GitHub contributors GitHub all releases

Screenshots

screenshot

Let Them Trade Map-Maker

ltt-mapmaker is a visual map-maker for the game Let Them Trade by Spaceflower, a german indie-gamestudio.

Using lttmm

Simply click on a button in the center of a tile and select the tile you want it to change to. Do so for the whole map. After your map looks good to you, hit the "DOWNLOAD MAP"-button in the top-right. This will generate a .json-file and download it which will contain your configuration as a Let Them Trade map.

TODOs

  • Add infobutton/box telling users how to load their maps in-game (so far only relevant for playtests) map fromfile - Opens an "Open file"-dialog

Using/Deploying lttmm

Deploying lttmm as a website

If you wish to manually deploy lttmm, download the latest lttmm-x.x.x.tar.gz or lttmm-x.x.x.zip from the Releases page and use these files to deploy it. I expect you to know how to deploy these files with NGINX or similar software, as providing a complete guide on how to do so would blow up the README.

Using the Electron App

If you wish to use Let Them Trade Map-Maker as an app, download the archive fitting to your OS from the Releases page. Currently available are macOS, Linux Ubuntu and Windows builds.

  • When using the Linux build, you may need to chmod +x the binary first.
  • When using macOS, you may need to adjust your Security preferences first and trust the app.

Docker

Docker-Compose

Create a docker-compose.yml-file in your preferred location and add the following to it after editing it to your liking:

version: '3'
services:
  ltt-mapmaker:
    image: ghcr.io/griefed/ltt-mapmaker:latest
    container_name: ltt-mapmaker
    restart: unless-stopped
    environment:
      - TZ=Europe/Berlin # Your Timezone
      - PUID=1000 # Your user ID
      - PGID=1000 # your group ID
    ports:
      - 80:80
      - 443:443

After running docker-compose up -d, lttmm will be available at localhost:80 and localhost:443.

Docker run

Run the following command, after editing it to your liking:

docker create \
  --name=ltt-mapmaker \
  -e TZ=Europe/Berlin `# Your Timezone` \
  -e PUID=1000 `# Your user ID` \
  -e PGID=1000 `# Your group ID` \
  -p 80:80 \
  -p 443:443 \
  --restart unless-stopped \
  ghcr.io/griefed/ltt-mapmaker:latest

After running the command above, lttmm will be available at localhost:80 and localhost:443.

Making changes

If you wish to make changes, simply clone this repository, install the dependencies with npm install, start the app in development mode (hot-code reloading, error reporting, etc.) with quasar dev and make your changes, lint the files npm run lint, build the app for production with quasar build.

Expanding/changing random map names

If you wish to expand/change the random name generator, edit const reticulating and/or getMapName() in the index.js.

Awesome People!

Contributors & Collaborators

Trungel
Trungel
Griefed
Griefed

Sponsors

kreezxil
Kreezxil

Bots

dependabot[bot]
dependabot[bot]
github-actions[bot]
github-actions[bot]

Other things to note