/Remnant2Tools

Tools for the game Remnant II (Main repo: https://gitlab.com/RobinKuiper/remnantcollectables)

Primary LanguageTypeScript

Remnant Tools

Website Latest Release pipeline status

Description

Remnant Tools is a web application designed to help players of the game "Remnant II" track their progress, triumphs, and collectibles. It provides a comprehensive set of features to enhance the gaming experience and assist players in optimizing their gameplay.

Features

  • Triumph and collectible tracker: Keep track of your progress and achievements in the game.
  • Build management: Create and save character builds with customizable equipment and trait allocations.
  • Statistics panel: View detailed statistics and insights about your gameplay and progress.
  • Secret worlds panel: Discover hidden secrets and explore secret worlds within the game.

Installation

  1. Clone the repository: git clone https://gitlab.com/RobinKuiper/remnantcollectables.git
  2. Install dependencies: pnm install
  3. (Optional) For a working integration with Google Drive, copy the example.env to .env and fill the values.

Usage

  1. Start the development server: pnpm start
  2. Open your web browser and navigate to http://localhost:8000 to access the application.

Scripts

  • pnpm start: Start the development server.
  • pnpm build: Build the project for production.
  • pnpm test: Run tests using Jest.
  • pnpm lint: Run ESLint to lint the source code.
  • pnpm prettier: Format the code using Prettier.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request. You can also support the development of this project by becoming a Patron or making a donation via PayPal.

Patreon PayPal

Contact

If you have any questions or suggestions, feel free to reach out:

Discord LinkedIn Website

License

This project is licensed under the MIT License.