Giter Club home page Giter Club logo

eshaton's Introduction

Eshaton, a character application for Degenesis

  1. About
  2. Features
  3. Usage
    1. Characters
    2. Campaigns
  4. Links
  5. Self-Hosting
    1. Scripts
  6. Development
    1. Plans
    2. Known Issues

About

Eshaton is a web application that helps players save, upload, download, and view their Degenesis characters. All characters created can be exported as a .degenesis (internally json) file, or can be stored in the server-side database.

Features

  • Players may login and save their character to a database, or import/export as they wish.
  • Gamemasters can create campaigns, and add characters.
  • Roll dice on the website or send the roll results to a discord server.
  • Degenesis map, powered by leaflet.

Usage

Characters

  • Character Sheet: Players may create, edit, and delete characters. A character name must be provided for it to be saved to the database. Character names cannot be changed after the character is saved to the database.

  • Exporting/Importing: Players may download their character data by clicking the Export Character button, and they may upload it back via the Import Character button.

  • In-Campaign Characters: If a character is added to a Campaign, editing feature will be disabled but viewing feature will replace it. You may roll dice via the viewing feature. If the campaign that the character is added has discord features enabled and configured, dice roll will be sent to the channel that is provided.

Campaigns

  • Campaign Sheet: Gamemasters may create, edit and delete campaigns. A campaign name is required to save it to the database. Campaign names cannot be changed after it is saved to the database.

  • Character-Campaign Connection: Gamemasters may add and remove characters from their campaigns. Navigate to the campaign editing mode to enable these functionality. You may add or remove a character by providing their secret keys, which are accessed via the key icons on the left.

  • Discord Integration: Discord functionality may also be enabled to send the dice rolls of the campaign-added characters to a discord server. This requires both the bot to be added to the server and gamemaster to enable and enter required info on their campaign sheet.

    1. Adding the Bot: Add the bot to your server with this link.

    2. Authorize Server: First, you have to check the box named Discord Bot Integration Enabled to authorize the server to send messages then you have to fill the input boxes below it.

    3. Add Server ID: Enter your Server ID (which can be found under Server Settings > Widget > Server ID, example: 1234567890) into Discord Server ID box.

    4. Add Channel Name: Enter name of the channel that you want the bot to send the messages (without the hashtag, example: dice-rolls) into Discord Channel Name box.

Links

Degenesis: Rebirth

Degenesis: Rebirth Official Discord

Self-hosting

This package is created for Heroku, with React, Expressjs and PostgreSQL. Go through the classic npm i routine and such after installing PostgreSQL database and node.

Scripts

npm run build

Builds both Client and Server-side code. This is also used by Heroku.

npm run start

This is used by Heroku to start the application.

npm run dev

This is used during development. This starts both the server (on port 4000), and the client (on port 3000).

Development

Plans

  • Custom tooltips instead of browser-style tooltips.
  • Recheck the server security.
    • Especially with import/export functionality.
  • Add a way for campaign owners to view the players' character sheets.
  • Add a way for players to submit edited character sheets to the campaign owner approval.
  • Character portraits should be visible on client-side if players provide a direct link.
  • Add Cult/Culture/Concept and other details on client-side for hover-over info.

Known Issues

Please submit your issues to the issues page.

  • None yet, but I'm sure the server will go down eventually soon.

eshaton's People

Contributors

yigitlevent avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.