Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/afcms/minetest-skin-server
⚠️ WIP Skin server for the Minetest engine
https://github.com/afcms/minetest-skin-server
golang minetest minetest-tool react server
Last synced: 11 days ago
JSON representation
⚠️ WIP Skin server for the Minetest engine
- Host: GitHub
- URL: https://github.com/afcms/minetest-skin-server
- Owner: AFCMS
- License: gpl-3.0
- Created: 2022-12-19T10:28:28.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-09T21:57:00.000Z (28 days ago)
- Last Synced: 2024-10-10T22:16:25.771Z (27 days ago)
- Topics: golang, minetest, minetest-tool, react, server
- Language: Go
- Homepage:
- Size: 1.32 MB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Minetest Skin Server
> [!IMPORTANT]
> This server is still in development and is not ready for production use.
> Breaking changes may occur at any time.
This server is made for serving Minetest skins to Minetest servers. It is licensed under GPLv3.
- ✅ Easy to use and powerful **API**
- ✅ Skins compatible with both **MineClone2** and **Minetest Game**
- ✅ Fast and reliable, thanks to **Docker**, **Golang**, **Fiber** and **PostgreSQL**
- ✅ Optimised images using **OptiPNG**
## Design
The server is build with the [**Go**](https://go.dev) language on-top of the [**Fiber**](https://gofiber.io) framework.
It uses also the [**GORM**](https://gorm.io) library for interacting with the database.
The frontend is build with the [**React**](https://reactjs.org) library, the [**Vite**](https://vitejs.dev) framework
and the following libraries:
- [**TailwindCSS**](https://tailwindcss.com) for styling
- [**HeadlessUI**](https://headlessui.com) for dialogs, combobox, etc
- [**Heroicons**](https://heroicons.com) for most icons
- [**React Router**](https://reactrouter.com)
- [**React Three Fiber**](https://github.com/pmndrs/react-three-fiber) for the 3D preview of skins
## Running Server
### Development (Docker)
#### 1. Install `docker`
Follow the official guide for your OS.
- [Ubuntu](https://docs.docker.com/engine/install/ubuntu)
- [Debian](https://docs.docker.com/engine/install/debian)
- [Fedora](https://docs.docker.com/engine/install/fedora)
- [RHEL/CentOS](https://docs.docker.com/engine/install/centos)
> [!NOTE]
> The installation links are from Docker Engine, which works only under Linux.
>
> [Docker Desktop](https://www.docker.com/products/docker-desktop) can be used on Windows, MacOS and Linux.
>
> It runs a Linux VM in the background and isn't as performant as the native version, but it's easier to install and
> use.
> [!WARNING]
> You need a [BuildKit](https://docs.docker.com/build/buildkit) enabled version of Docker to build the image.
#### 2. Download source code
```shell
git clone https://github.com/AFCMS/minetest-skin-server && cd minetest-skin-server
```
#### 3. Configure server
```shell
cp exemple.env .env
```
Edit the `.env` file with the config you want.
A typical production config would be:
```ini
MT_SKIN_SERVER_DATABASE_LOGGING=false
MT_SKIN_SERVER_ENABLE_OPTIPNG=true
MT_SKIN_SERVER_DB_HOST=db
MT_SKIN_SERVER_DB_USER=user
MT_SKIN_SERVER_DB_PASSWORD=azerty
MT_SKIN_SERVER_DB_PORT=5432
MT_SKIN_SERVER_DB_NAME=skin_server
```
#### 4. Run services
```shell
docker compose -f compose.dev.yml up --build
```
You will now have access to the app (both frontend and API) at `http://localhost:8080`. Doing changes to the frontend
files will trigger fast refresh without needing to restart the entire app.
### Development (host, not recommended)
It's possible to run the server without Docker, but it's not recommended.
#### 1. Install Go and NodeJS
Follow the official guides for you OS.
I recommend using NodeJS v20 installed using [**nvm**](https://github.com/nvm-sh/nvm) under linux.
#### 2. (Optional) Install OptiPNG
If you want to enable [OptiPNG](https://optipng.sourceforge.net), you need to install it.
On Ubuntu/Debian:
```shell
sudo apt install optipng
```
On Fedora/RHEL:
```shell
sudo dnf install optipng
```
#### 3. Download source code
```shell
git clone https://github.com/AFCMS/minetest-skin-server && cd minetest-skin-server
```
#### 4. Install Go dependencies
```shell
go mod download
```
#### 5. Install NodeJS dependencies
```shell
cd frontend && npm install --include=dev && cd ..
```
#### 6. Configure server
```shell
cp exemple.env .env
```
Edit the `.env` file with the config you want.
A typical development config would be:
```ini
MT_SKIN_SERVER_DATABASE_LOGGING=false
MT_SKIN_SERVER_ENABLE_OPTIPNG=true
MT_SKIN_SERVER_DB_HOST=db
MT_SKIN_SERVER_DB_USER=user
MT_SKIN_SERVER_DB_PASSWORD=azerty
MT_SKIN_SERVER_DB_PORT=5432
MT_SKIN_SERVER_DB_NAME=skin_server
```
You need a PostgreSQL database running on the given host and port.
#### 7. Frontend
The frontend served by the Fiber backend can be build before running the app and served statically, the Vite development
server can also be proxied by the backend to avoid rebuilding everytime.
Static files can be built like this before launching the server:
```shell
cd frontend && npm run build && cd ..
```
If you want to use Vite's development server, you can run it like this:
```shell
cd frontend && npm run dev
```
With the following additional configuration in the `.env` file:
```ini
MT_SKIN_SERVER_FRONTEND_DEV_MODE=true
MT_SKIN_SERVER_FRONTEND_URL=http://localhost:5173
```
> [!CAUTION]
> The Vite server configuation makes it exposed on your local network by default to make it accessible in Docker, you
> can change this
> behaviour in the Vite configuration.
#### 8. Build and run backend
```shell
go build && ./minetest-skin-server
```
### Production
There is an [exemple](https://github.com/AFCMS/minetest-skin-server/blob/master/compose.prod.yml) production Docker
Compose file in the repository.
It uses the [production image](https://github.com/AFCMS/minetest-skin-server/pkgs/container/minetest-skin-server) built
by the GitHub Actions workflow, which supports `amd64`, `arm64`, `ppc64le`, `s390x`, `386` architectures.
```shell
docker pull ghcr.io/afcms/minetest:master
docker compose -f compose.prod.yml up
```
You can verify that the image have been really built by the GitHub Actions workflow and find the build log using the GitHub CLI:
```shell
gh attestation verify oci://ghcr.io/afcms/minetest-skin-server:master --repo AFCMS/minetest-skin-server
```
#### Configuration
For production the server supports some more configuration variables.
##### Google Search Console Verification
The server can use the HTML tag verification method for
the [Google Search Console](https://search.google.com/search-console) (URL prefix).
You can set the `MT_SKIN_SERVER_VERIFICATION_GOOGLE_SEARCH_CONSOLE` environment variable to Google's verification token.
You can also use the DNS record method if you want, please
checkout [Google's documentation](https://support.google.com/webmasters/answer/9008080) for more information.
##### OAuth2
The server supports OAuth2 for authentication, you can set the following environment variables to enable it.
If one of the two variables (client id, client secret) for a provider are not set, OAuth2 will be disabled for that
provider.
- `MT_SKIN_SERVER_OAUTH_REDIRECT_HOST`: the host where the OAuth2 callback will be redirected to
- ContentDB:
- `MT_SKIN_SERVER_OAUTH_CONTENTDB_CLIENT_ID`: the OAuth2 client ID for the ContentDB API
- `MT_SKIN_SERVER_OAUTH_CONTENTDB_CLIENT_SECRET` the OAuth2 client secret for the ContentDB API
- `MT_SKIN_SERVER_OAUTH_CONTENTDB_URL`: the URL of the ContentDB instance, default to `https://content.minetest.net`
- [Create Application](https://content.minetest.net/user/apps/)
- GitHub:
- `MT_SKIN_SERVER_OAUTH_GITHUB_CLIENT_ID`: the OAuth2 client ID for the GitHub API
- `MT_SKIN_SERVER_OAUTH_GITHUB_CLIENT_SECRET` the OAuth2 client secret for the GitHub API
- [Create Application](https://github.com/settings/applications/new)
## Development Tools
I recommand using either **VSCode** or **GoLand**.
There are multiple VSCode extensions marked as recommended for the workspace.