Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shiroyashik committed Jun 16, 2024
1 parent 3931275 commit ca6990c
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
## The Sculptor
# The Sculptor

[![Rust](https://github.com/shiroyashik/sculptor/actions/workflows/rust.yml/badge.svg?branch=master)](https://github.com/shiroyashik/sculptor/actions/workflows/rust.yml)

Unofficial backend V2 for the Minecraft mod [Figura](https://github.com/FiguraMC/Figura).

Implements Ping transmission functionality via Websocket and full avatar upload and download functionality. Currently incomplete and under active development

And also a distinctive feature is the possibility of player identification through the third-party authorization system [Ely.By](https://ely.by/)

### Running with Docker
## Usage

### Docker

You will need an already configured Docker with Traefik (you can use any reverse proxy)

Expand All @@ -16,23 +20,28 @@ You will need an already configured Docker with Traefik (you can use any reverse
4. Open docker.compose.yml and uncomment the "labels" to work with Traefik and add the container to the network with Traefik.
5. `docker compose up -d` this will build and run the container with

### Just running
### Native

Running this way you won't need WSL when running on Windows, but....

To do this, you will need to reverse proxy port 6665 to your domain with SSL

1. Create avatars folder (it will store player avatars)
2. Copy Config.example.toml and rename it to Config.toml
3. Set up your reverse proxy server
4. `cargo run`

### Public server
> [!IMPORTANT]
> NGINX requires additional configuration to work with websocket!
## 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.

[Check server availability](https://figura.shsr.ru/health)

0 comments on commit ca6990c

Please sign in to comment.