Skip to content

noah-owens/Character-Forge

Repository files navigation

Character Forge - v0.5.0

Build Status codecov

Progress Note

After a lot of consideration, this project of 5 months is being restructured from the ground up to provide more robust support for multiclassing, spells, and higher level play. I have also decided to focus on creating more readable and organized boilerplate code, rather than avoiding it entirely with Lombok. Lombok has been incredibly convenient, but writing my own accessor and mutator methods has so far led to more thoughtful and cohesive design.

About

Character Forge is an app for creating D&D characters and NPCs based on a completely hands-off approach. Certain features may be specified, but it's never a requirement! Character Forge has been designed with accessibility and ease of use in mind, so that anyone on any system can install, run, and have a random character or NPC statblock ready to go at a moment's notice.

Built With

Getting Started

Until I reach my first production release, I will not be providing a JAR. That doesn't mean you can't try it out though! To install the program, first open your terminal and clone the repository to your machine using:

git clone https://github.com/noah-owens/Character-Forge.git

Next, make sure you have an up-to-date Gradle installation and JDK. Navigate to the project directory in your command prompt, then you're all good to build and run the app using Gradle:

gradle build
gradle run

Contributing

Character Forge is not currently accepting contributions.

Contact

Noah Owens - [email protected]

Project Link - https://github.com/noah-owens/Character-Forge

Support

If you like what's going on here, feel free to support me on Ko-Fi! I'd really appreciate it.

Acknowledgements

License

Copyright (c) 2022 Noah Owens

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.