fultimator / fultimator

A tool for creating homebrew adversaries, characters and items for Fabula Ultima.

Home Page:https://fabula-ultima-helper.web.app/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

alt text

Fultimator

Introduction

An unofficial Fabula Ultima Tool

It contains multiple tools to manage a game of Fabula Ultima.

Fultimator is an independent production by the Fultimator Dev Team and is not affiliated with Need Games or Rooster Games. Supplied game rules in the system compendium adhere to and are published under the Fabula Ultima Third Party Tabletop License 1.0. We adhere to RoosterEma's guidelines, ensuring that the core book and its supplements remain integral to your experience. To fully utilize this system, you will need the Fabula Ultima Core Rulebook.

This repository's source code is subject to the terms of the MIT License. For further details, please refer to the LICENSE file included in this repository.

Welcome to the contribution guidelines for Fultimator! We appreciate your interest in improving our web app. Please follow the guidelines below for code and content contributions.

Communication Channels

If you have any questions or concerns, feel free to reach out to us through the following channels:

Submitting Issues

Issues reported on GitHub and support channels will be reviewed. Please follow the guidelines below for different types of issues.

Bugs

Before submitting a bug report, ensure the following:

  • Bugs are reproducible, do note if the issue is due to web browser configuration or third party extensions.
  • Include clear instructions on reproducing the issue and the expected vs actual outcome.

Tooling and Setup

Fultimator uses React for building dynamic user interfaces, ultizes Firebase for its backend infrastructure, and Material UI for it's React component UI library.

Branches

  • main: The mainline branch intended for deployment to Firebase.
  • dev: The primary development branch for most features.

When opening a pull request (PR), ensure it goes into the most relevant branch.

Prerequisite Software

Setup

Clone the repository using the following command in your terminal:

git clone https://github.com/greg-argulla/fultimator.git

Then, navigate to the project folder and use npm to download dependencies locked in package-lock.json

npm ci

Building from Source

To start the application locally you can run:

npm run start

To create an optimized production build:

npm run build

This will help you visualize and test your changes locally.

Deploy

The app is hosted by firebase.

To deploy you need to have firebase installed. See firebase - npm

You also need to have the proper permissions. See Firebase IAM permissions.

$ npm run deploy

This command will build a production version of the app, and upload it to firebase.

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.

Special thanks to the following contributors found here: Contributors Link

About

A tool for creating homebrew adversaries, characters and items for Fabula Ultima.

https://fabula-ultima-helper.web.app/

License:MIT License


Languages

Language:JavaScript 89.7%Language:TypeScript 9.9%Language:HTML 0.4%