updated README
This commit is contained in:
parent
31f64aef5f
commit
fdfa9c9740
33
README.md
33
README.md
|
@ -1,20 +1,41 @@
|
||||||
# Rustmon
|
# Rustmon
|
||||||
|
|
||||||
*For educational purposes*
|
A feature-rich, versatile colorscript printer written in Rust.
|
||||||
A simple colorscript written in Rust.
|
|
||||||
|
|
||||||
Inspired by [phoneybadger's pokemon-coloscripts](https://gitlab.com/phoneybadger/pokemon-colorscripts).
|
Inspired by [phoneybadger's pokemon-colorscripts](https://gitlab.com/phoneybadger/pokemon-colorscripts).
|
||||||
|
|
||||||
## Performance
|
## Performance
|
||||||
|
|
||||||
This is written in Rust, while the original is written in Python.
|
This is written in Rust, while the original is written in Python.
|
||||||
This implementation is up to 8 times faster than the original.
|
This implementation is up to 10 times faster than the original.
|
||||||
|
(Sixteen times the detail)
|
||||||
|
|
||||||
|
This is the Rust implementation:
|
||||||
|
![rust implementation](img/screenshot_220424_202018.png)
|
||||||
|
|
||||||
This is the Python implementation:
|
This is the Python implementation:
|
||||||
![python implementation](img/screenshot_250324_132129.png)
|
![python implementation](img/screenshot_250324_132129.png)
|
||||||
|
|
||||||
This is the Rust implementation:
|
## Features
|
||||||
![rust implementation](img/screenshot_250324_132205.png)
|
|
||||||
|
## Printing
|
||||||
|
|
||||||
|
- Print a colorscript of a Pokemon.
|
||||||
|
- Print a chungus colorscript of a Pokemon.
|
||||||
|
- Specify your custom shiny rate.
|
||||||
|
- Specify the colorscript by Pokemon name.
|
||||||
|
- Specify the colorscript by Pokedex ID.
|
||||||
|
- Print multiple colorscripts at once in a row.
|
||||||
|
- Print different colorscript forms of a Pokemon.
|
||||||
|
|
||||||
|
## Fetching
|
||||||
|
|
||||||
|
- Fetch the colorscript of a Pokemon from the internet.
|
||||||
|
- Extract to a custom location for your own use.
|
||||||
|
|
||||||
|
## Coming soon
|
||||||
|
|
||||||
|
- Pokemonsay, inspired by cowsay. Will be accessible by the subcommand `say`.
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
pkgname=rustmon-git
|
pkgname=rustmon-git
|
||||||
pkgdesc="Pokemon Colorscripts written in Rust"
|
pkgdesc="Pokemon Colorscripts written in Rust"
|
||||||
_gitname=rustmon
|
_gitname=rustmon
|
||||||
pkgver=r46.5aa2597
|
pkgver=r47.31f64ae
|
||||||
pkgrel=1
|
pkgrel=1
|
||||||
arch=('x86_64')
|
arch=('x86_64')
|
||||||
url="https://github.com/Vomitblood/$_gitname"
|
url="https://github.com/Vomitblood/$_gitname"
|
||||||
|
@ -22,6 +22,7 @@ pkgver() {
|
||||||
}
|
}
|
||||||
|
|
||||||
build() {
|
build() {
|
||||||
|
# fix linking errors
|
||||||
export CFLAGS="-fPIE"
|
export CFLAGS="-fPIE"
|
||||||
cd "$srcdir/$_gitname"
|
cd "$srcdir/$_gitname"
|
||||||
# build main program
|
# build main program
|
||||||
|
|
BIN
img/screenshot_220424_202018.png
Normal file
BIN
img/screenshot_220424_202018.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 41 KiB |
|
@ -1,6 +1,4 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
# TODO: temp install script for arch
|
|
||||||
|
|
||||||
cd build/arch
|
cd build/arch
|
||||||
makepkg -cfsi
|
makepkg -cfsi
|
Loading…
Reference in a new issue