Create README.md

This commit is contained in:
bakustarver 2024-03-07 22:04:11 +02:00 committed by GitHub
parent 8485ed7a33
commit dac0bd0c03
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

109
README.md Normal file
View file

@ -0,0 +1,109 @@
# RPG Maker MV / MZ - Cicpoffs
The project contains a collection of shell scripts that will help you run games on the RPG Maker MV/MZ engine.
#### Contains the following functions:
- Running any MV/MZ engine game on linux.
- Load and select any version of NWJS (using the command line).
- Running a game with the Japanese locale option.
- Launching a game with a command line.
- Show the NWJS, Nodejs, Chromium versions of your game.
- Support of four linux architectures: x86-64, i386, armhf, arm64
After installing the program you can run the game using an application - "RPG Maker MV/MZ (cicpoffs mount)"
#
![img](https://github.com/bakustarver/rpgmakermlinux-cicpoffs/assets/66978329/4d55e52a-fe6d-44a5-a7bb-9380218d16f1)
## Installation
```
wget -qO- "" | bash
```
## Command line Options
#### Run the rpg maker game
```
rpgmaker-linux
```
```
rpgmaker-linux --gamepath /path/rpg-maker-game/
```
#### Show version of the programm
```
rpgmaker-linux --version
```
#### Update the nwjs to the latest version
```
rpgmaker-linux --updatenwjs
```
#### Print rpg maker game libraries versions
```
rpgmaker-linux --gamepath /path/rpg-maker-game/ --printrpgmakerlibversions
```
#### Choose the version of NWJS you want to use:
```
rpgmaker-linux --nwjsversion 0.40.0 --gamepath /path/rpg-maker-game/
```
#### In certain games you may need the Japanese locale use:
```
rpgmaker-linux --jpnlocale --gamepath /path/rpg-maker-game/
```
#### Show donations links:
```
rpgmaker-linux --sourcelinks
```
## Support the author of the program:
[Patreon](https://www.patreon.com/user/about?u=121421184)
[Buymeacoffee](https://www.buymeacoffee.com/rpgmakerlinux)
##