https://github.com/erikgartner/xeed
A program for organising roleplaying settings and their characters, groups and relationships.
https://github.com/erikgartner/xeed
characters role-playing role-playing-game
Last synced: 16 days ago
JSON representation
A program for organising roleplaying settings and their characters, groups and relationships.
- Host: GitHub
- URL: https://github.com/erikgartner/xeed
- Owner: ErikGartner
- License: apache-2.0
- Created: 2015-12-06T20:43:22.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-06-30T19:56:27.000Z (almost 3 years ago)
- Last Synced: 2024-10-05T10:59:49.860Z (7 months ago)
- Topics: characters, role-playing, role-playing-game
- Language: Java
- Homepage:
- Size: 22.3 MB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# XEED
*XEED is a tool that organizes role-playing settings. It focuses on story driven games and does not have map support.*
The goal of XEED is to help the game master to store and organize the vast amount of data in a roleplaying setting. The main focus is the characters and their most important traits such as background, personality, relations and factions/groups rather than individual stats. XEED is written in Java and aims at being platform independent.
## Key Features
- A modular template system that allows XEED to adapt to a variety of games.
- User can create their own character templates.
- A customizable main window; display only the data need.
- Organize your notes, groups, characters and relationships in one compact file format.
- Visualize your data with graphs.
- An autosave function ensures your data is safe in case of crashes.
- Optional autoupdate feature that updates to the latest version.
- Export your setting information to HTML, PDF, TXT, or [dTree](https://github.com/ErikGartner/dtree) graphs.
## Usage
The latests release can be found under ["releases"](https://github.com/ErikGartner/xeed/releases).
### Installation
XEED uses maven for building executable jars with bundled dependencies.
```
mvn package
```
It will generate a ```target/``` folder with the compiled jars.
### Running
Depending on the host system either double click on the built jar files or type:
```
java -jar XEED.jar
```
## Tests
None at the moment but they should be stored in ```src/test/java/```.
## Contributions
Pull requests are welcome. Main developer is @erik_gartner.
### Problems
This project is very old and suffers from incorrect code conventions, bad patterns and a tangled structure. Fixing these problem should be considered high priority before developing new features.
For example:
- Variables have the type as prefix.
- Methods start with a capital letter.
- The coupling is very high.
- Potential threading problem.
- Propagating changes between forms is mess.
- Main class is way to big and contains and breaks many OOP principles.
Despite these problem the program is generally stable and extended usage over several years have only revealed minor bugs.
## License
Copyright 2015 Erik Gärtner
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.