shiroyashik/sculptor
1
0
Fork 0
mirror of https://github.com/shiroyashik/sculptor.git synced 2025-12-06 04:51:13 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added README in Russian + Prepare for v0.4.0 version

Browse source
This commit is contained in:
Shiroyasha 2024-10-12 21:10:50 +03:00
parent c0bf550eb8
commit 7a4f3dc7a5
Signed by: shiroyashik
GPG key ID: E4953D3940D7860A
5 changed files with 132 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -1,13 +1,33 @@
- English
- [Русский](README.ru.md)
# The Sculptor
[![Push Dev](https://github.com/shiroyashik/sculptor/actions/workflows/dev-release.yml/badge.svg?branch=dev)](https://github.com/shiroyashik/sculptor/actions/workflows/dev-release.yml)
Unofficial backend V2 for the Minecraft mod [Figura](https://github.com/FiguraMC/Figura).
Unofficial backend for the Minecraft mod [Figura](https://github.com/FiguraMC/Figura).
Is a worthy replacement for the official version. Realized all the functionality that can be used during the game.
And also a distinctive feature is the possibility of player identification through third-party authentication providers (such as [Ely.By](https://ely.by/))
## Public server
[![Server status](https://up.shsr.ru/api/badge/1/status?upLabel=Online&downLabel=Offline&label=Server+status)](https://up.shsr.ru/status/pub)
I'm keeping the public server running at the moment!
You can use it if running your own Sculptor instance is difficult for you.
To connect, simply change **IP Server** in Figura settings to the address below:
> figura.shsr.ru
Authentication is enabled on the server via: Mojang and [Ely.By](https://ely.by/)
For reasons beyond my control, the server is not available in some countries.
## Launch
To run it you will need a configured reverse proxy server.
@ -48,25 +68,15 @@ cp Config.example.toml Config.toml
nano Config.toml
# Build it in release mode for better performance
cargo build --release
# or run from cargo
cargo run --release
```
## Public server
[![Server status](https://up.shsr.ru/api/badge/1/status?upLabel=Online&downLabel=Offline&label=Server+status)](https://up.shsr.ru/status/pub)
I'm keeping the public server running at the moment!
You can use it if running your own Sculptor instance is difficult for you.
> figura.shsr.ru
For reasons beyond my control, the server is not available in some countries.
## Contributing
If you have ideas for new features, have found a bug, or want to suggest improvements,
please create an [issue](https://github.com/shiroyashik/sculptor/issues)
or contact me directly via Discord (@shiroyashik).
or contact me directly via Discord/Telegram (@shiroyashik).
If you are a Rust developer, you can modify the code yourself and request a Pull Request:
@ -74,11 +84,11 @@ If you are a Rust developer, you can modify the code yourself and request a Pull
2. Create a new branch for your features or fixes.
3. Submit a PR.
Glad for any help from ideas to PRs.
Glad for any help from ideas to PRs. ❤
#### P.S.
The [“master”](https://github.com/shiroyashik/sculptor/tree/master) branch contains the source code of the latest release. A [“dev”](https://github.com/shiroyashik/sculptor/tree/dev) branch is used for development.
The [“master”](https://github.com/shiroyashik/sculptor/tree/master) branch contains the source code of the latest release. [“dev”](https://github.com/shiroyashik/sculptor/tree/dev) branch is used for development.
## License