Skip to content

Barebones Neptune, LineSDK and Toro Puzzle API recreations for town-restoration

License

Notifications You must be signed in to change notification settings

zUltimaPG3D/toro-webserver

Repository files navigation

Toro Webserver
toro-webserver

A barebones NeptuneSDK, LineSDK and Toro Puzzle API server recreation for town-restoration.

Overview • How To Use (non-dockerized or dockerized) • SetupCreditsOthers like thisLicense

WARNING!

This project is still in development. A lot of game endpoints are still missing and still need to be implemented. A lot of things may also change in the future, like the save data handling and more.

Overview

Toro and Friends: Onsen Town, a mobile Doko Demo Issyo game mostly based around connect-three puzzles, had two versions: the Japanese version and the Localized version.

The Localized version of the game died just like the Japanese version, but unlike the Japanese version, no patch was made for it to run independently of the servers.

This project is a recreation of most of the services the Localized version of the game uses, which makes the game finally work again, as long as certain modifications are made to the game itself (such as using town-restoration).

How To Use (non-dockerized)

This program depends on Deno to run.

Assuming you already have it installed, you can set up the program like so:

# Clone the repository
$ git clone https://github.com/zUltimaPG3D/toro-webserver

# Go into the repository
$ cd toro-webserver

# Install dependencies
$ deno install

# Follow the instructions in the "Setup" section
# before you run the server

# If the user doesn't have write permissions
# $ sudo chown -R deno:deno ./player_data

# Run the program
$ deno task run

How To Use (dockerized)

Alternatively, you can use Docker to run the program.

Currently, there is no prebuilt image, but you can build one yourself and run it like so:

# Clone the repository
$ git clone https://github.com/zUltimaPG3D/toro-webserver

# Go into the repository
$ cd toro-webserver

# Follow the instructions in the "Setup" section
# before you build the image

# Build the image
$ docker build . -t toro-webserver

# Run the image
$ docker run -p 15151:15151 toro-webserver
  • Note: It is recommended to use volumes to make the ./player_data directory persistent, so that data is not lost with the container.

Setup

Before running the server, you will have to edit the config.json file to match the port and IP address (and the scheme, if you want to use HTTPS) of your server.

If you're hosting the server and link to it via a domain, you can either change ip to the server's IP address, or you can change it to the domain. Both will work, as long as doing scheme://ip:port/ works.

If you're using a domain where the server runs without a separate port (for example http://some-domain.com/ directly) and you have something using port 80 or 443, you cannot use the domain as ip because port would have to be 80 or 443, which wouldn't work as two different programs can't use the same port at the same time. You instead have to use the server's IP address and the port of the server has to be different (15151 should be fine).

If the server is running through a domain like http://some-domain.com/server/, you cannot use the domain for ip.

Credits

  • puzzle by synzr (Apache 2.0): Used as reference for early server development
  • Markdownify by Amit Merchant (MIT): Used the README as a base for this project's README
  • Deno by the Deno team (MIT): Used as the runtime for this project

Others like this

  • puzzle by synzr (Apache 2.0): An (incomplete) server recreation for Onsen Town written in JavaScript (Node.js)

License

GPL v3


About

Barebones Neptune, LineSDK and Toro Puzzle API recreations for town-restoration

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages