Fultimator (Desktop Version)

Introduction

Fultimator is a desktop application designed to manage your Fabula Ultima games.

• Fabula Ultima: Official Website
• Fultimator: Web Application - Github

The application provides various tools to help you manage and enhance your Fabula Ultima gameplay experience.

Fultimator is an independent production by the Fultimator Dev Team and is not affiliated with Need Games or Rooster Games. The game rules in the system compendium are published under the Fabula Ultima Third Party Tabletop License 1.0. To fully utilize this system, you will need the Fabula Ultima Core Rulebook.

The source code of this project is licensed under the MIT License. For more details, please refer to the LICENSE file in this repository.

Download

You can download the latest release of the Fultimator desktop application from our Releases Page.

Communication Channels

For questions or concerns, you can reach out through the following channels:

• Developer Discord: Fultimator - #development channel
• Discord: Rooster Games - #bot-and-tool-discussion channel

Submitting Issues

Please report issues on GitHub. Ensure that you follow these guidelines:

Bugs

Before submitting a bug report:

• Verify that the bug is reproducible and not caused by your desktop environment or third-party extensions.
• Provide clear reproduction steps and describe the expected versus actual behavior.

Tooling and Setup

Branches

• main: The main branch intended for deployment.
• dev: The primary development branch for feature updates and changes.

When submitting pull requests (PRs), ensure they target the appropriate branch.

Prerequisite Software

• Git
• Node.js v16.16.0 (LTS)
• Code editor (recommended: Visual Studio Code)
• Electron (for building and running the desktop app)

Setup for Developement

Clone the repository using:

git clone https://github.com/acinoroc/fultimator-desktop.git

Navigate to the project folder and install dependencies:

npm ci

Change the .envInfo and public/configInfo.json files into .env and public/config.json and add your personal keys.

Building and Running

To start the application locally (browser mode), use:

npm run start

Bare in mind that only offline features work in browser mode.

To start the application locally with electron, use:

npm run electron-test

This command creates an optimized production build and runs the app locally inside electron.

Deployment

To package and distribute the desktop application, ensure you have Electron and the necessary permissions. For more information, refer to Electron Documentation.

npm run package

This command packages the app for distribution for the current OS.

Project Contributors

Major thanks to the following contributors:

• Triex (matteosuppo) - The original creator of the fultimator webapp. The repository can be found here: Fultimator
• Alyx - For prolonging the project, providing useful features such as localization, adversary compendium and improving overall functionality of the webapp.
• spyrella - For ongoing updates to the system and maintainence of the project.
• acinoroc - Another active maintainer, lead developer of the Character Designer and main developer of the Desktop Version.

Special thanks to the following contributors found here: Contributors Link