Giter Club home page Giter Club logo

heroworkshop's Introduction

Hero Workshop

GitHub   GitHub release (latest SemVer)  

Hero Workshop is a Pen+Paper Role-Playing Game Hero Generator which can then be used to the play via a chat application.

Table Of Contents

Development

Prerequisites:

Build:

~/HeroWorkshop> mvn clean compile

Run:

~/HeroWorkshop> mvn spring-boot:run -Dspring-boot.run.arguments="--module-path \path\to\javafx-sdk\lib","--module-path "C:\Program Files\Java\javafx-sdk-14\lib" --add-modules javafx.base,javafx.controls,javafx.fxml,javafx.graphics,javafx.media,javafx.swing,javafx.web"

Package:

~/HeroWorkshop> mvn package

This will output a hero-workshop-${version}.jar in the target folder. This is a self-running JAR file, so it should be able to be double-clicked to run, though on Windows you may need to run via a command line: java -jar \path\to\jar\file. However, it currently does require the Java runtime to be installed. Native packaging is still TBD.

Description

At its core, The Star Wars Role-Playing Game (RPG) is about telling a story. The Game Master along with the players tell the story together, guiding the heroes through quests for credits and fame, battling with deadly foes, daring rescues, courtly intrigue, and much more. You explore the universe and sprawling galaxies of the Star Wars saga through the personification of the players heroes.

The Star Wars RPG is played in the D20 System. This means that to resolve an action in the D20 System, a player rolls a 20-sided die and adds modifiers based on the natural aptitude of the character (defined by six attributes: Strength, Dexterity, Constitution, Intelligence, Wisdom, Charisma) and how skilled the character is in various fields (such as in combat), as well as other, situational modifiers. If the result is greater than or equal to a target number (called a Difficulty Class or DC) then the action succeeds. This is called the Core Mechanic. This system is consistently used for all action resolution in the d20 System.

The Hero Workshop is designed to bridge the gap between the old fashioned way of writing everything down with a pen+paper and allow players to electronically create a Role-Playing Game (RPG) Hero for use with the Star Wars Role-Playing Game (RPG) and use that Hero to play with others via the application Game Chat module.

The application will consist of two modules: the Hero Workshop and The Game Master Module

  • By following the user guide and going the each tab, The Hero Generator Module allows a player to create a character in the Star Wars Universe for play in in the D20 System. The character can also be saved and open in The Game Master Module to allow play with other players.
  • At its core, The Game Master Module is a chat room hosted by The Game Master (GM) Module (Storyteller of the game). Players then connect to the chat session of the GM and load their character to use during play.

Installation

Installation can be achieved by extracting the archive (.zip) to a directory of your choosing and running the main application in the bin folder.

Usage

For application usage, please refer to our detailed USERGUIDE.md

Support

To submit and issue with the application:

Roadmap and Changelog

Roadmap (Planned Implementations)

Changelog

Contributing

For contribution, please refer to our detailed guide CONTRIBUTING.md

Authors and Acknowledgement

Authors

Troy Pilewski (@troypilewski)
Justin Nichols (@justinnichols)
15Nova22 (@15Nova22)

Acknowledgements

License

The project is licensed under the GNU General Public License v3.0. The full license can be found in our here.

Project Status

The project is currently in the initial phases of design and development.

heroworkshop's People

Contributors

15nova22 avatar dependabot[bot] avatar justinnichols avatar troypilewski avatar

Watchers

 avatar  avatar

heroworkshop's Issues

Write Database File

Write a JavaScript Object Notation (JSON) file to store all required character selection data from the Revised Core Rulebook.

User Interface Design

Design User Interface: Each of the below are screens that can be seen within the User Interface.

  • Hero Generator
    • Summary Tab
    • Description Tab
    • Abilities Tab
    • Species Tab
    • Class Tab
    • Skills Tab
    • Feats Tab
    • Equipment Tab
  • Source Book Selection
  • Preferences / Settings
  • Game Master Module

Build JSON Connection

  • Build Plain Old Java Objects (POJOs) base on core_rulebook.1.json
    • Species
    • Classes
    • Skills
    • Feats
    • Equipment
  • Write a single Java Connection Class utilizing Jackson's ObjectMapper
  • Write the Java Connection Class to handle the concatenation of multiple JSON files

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.