Mausritter Character Sheet is a web application for Mausritter mice character sheet. You can use it, freely, from https://mausritter-sheet.dco.ninja.
Mausritter is about small-scale adventurers in a huge world. Mouse adventurers who take on big challenges and face down grave danger.
Have a look at Mausritter website and Licence.
- Play your mouse
- Create a random mouse (implement Mouse creation rules from Mausritter Rules book),
- Translated in English, Español, Deutsch and Français,
- Manage hirelings,
- Roll dices with/without advantage or disadvantage,
- Drag'n'drop items or conditions on inventory slots
- Drag'n'drop in grit.
- Drag'n'drop in bank, retrieving item from bank cost 1% of its price.
- History of dices and other actions.
- Save and load whole character sheet from local storage. 12 slots are available. All data is saved in your browser, no server is needed.
- Import / Export of character sheet. Use this to load a character into another browser.
- Mouse can rest and advance in level, up to level 20.
See TODO.md for incoming features :-)
Another Mausritter application is Mausritter-Colony. It's a minimalist tool to help GM to manage their game table.
Some help will be welcome to translate to other languages. Currently we have:
- English by myself
- French by myself
- Spanish by CoyoteBlur
- German by Keter150
- Russian by Sorinqi
The desktop applications are in beta and should be used just for testing. They still contain bugs! They are available for Microsoft Windows, Apple Mac OS and GNU Linux. At this time, there is no mobile (Android or iOS) version.
To download, go to https://github.com/yar0d/mausritter-sheet/releases and search for the latest release named Application release.
The folder /src/locales/
contains all messages files in a simple JSON format. To translate' you just have to copy a file by modifying its name with the language code you're targeting. By example, to translate to Spanish (Castilian), I copy conditions.en-US.json
to conditions.es-ES.json
, then en-US.json
to es-ES.json
, and so on.
A ISO Language Code Table exits to help you find the correct language code.
Translations is easy. JSON files contains message formatted like that:
"original-message-in-english": "translation of the message in english"
You just have to translate the right part. Here is a short example, for French fr-FR:
"Languages": "Langues",
"Welcome to Mausritter Sheet!": "Bienvenue sur la fiche de personnage Mausritter !",
Note that the language name is translated into it's own language.
You just create a new mouse-names.??-??.json
as described above. Translations is simple, you can replace every string by yours.
When all messages are translated, you can open an issue on the github with the label i18n and a title like I've translated to ;-). You can also contact me on discord at Yar0d#3470
.
This application is made with Vue.js 3 and wave-ui.
For desktop application, I use Tauri.
Clone this repository and, install dependencies with yarn
.
- Create a branch.
- Do the developer work :)
- Commit the stuff in branch.
- When it's ready, publish the branch
git push --set-upstream origin BRANCH
. - Then create a public release the work with
yarn run release:publish
from the branch. - Create a merge request, on github it's a pull request with
base: main
<-compare: BRANCH
. Then merge it. - To deploy, get the main branch with
git checkout main ; git pull
- Build with
yarn run build
. - Deploy the directory
dist
.
yarn upgrade
npx tauri deps update
yarn serve
yarn serve:tauri
yarn lint
yarn build
yarn build:tauri
This will build a native application for your computer.
If you use docker-compose:
docker-compose up --build
or, with docker:
yarn build:docker
yarn serve:docker
- Publish a release with
yarn release:publish
- Build with
yarn build
. We now have a dist folder. - Send all content on the dist folder to your FTP server.
A release will contains all binaries for MacOS, Windows and Linux.
- Increment application version with
yarn release:publish
on main branch. - Create a pull request for base: release to compare: main.
- Merge this pull request. This will trigger publish action. It takes about 15 minutes to complete and have a draft of the release in https://github.com/yar0d/mausritter-sheet/releases.
- Edit the draft to your needs.