https://github.com/clxrityy/test-craft
A local Minecraft development server (1.2.4)
https://github.com/clxrityy/test-craft
docker docker-compose dockerfile minecraft minecraft-server server shell shell-script
Last synced: 2 months ago
JSON representation
A local Minecraft development server (1.2.4)
- Host: GitHub
- URL: https://github.com/clxrityy/test-craft
- Owner: clxrityy
- Created: 2025-01-22T12:51:59.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-16T04:54:15.000Z (over 1 year ago)
- Last Synced: 2025-08-23T04:29:19.698Z (10 months ago)
- Topics: docker, docker-compose, dockerfile, minecraft, minecraft-server, server, shell, shell-script
- Language: Dockerfile
- Homepage:
- Size: 75.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# test-craft 
###### A local Minecraft development server.
##### Requires:
- [Docker](https://www.docker.com/)
##### Includes:
- Minecraft server (hosted on port `25565`)
- 1.21.4
- Java
- Paper / Spigot / Bukkit support
- Plugins:
- [Essentials](https://essentialsx.net/)
- [WorldEdit](https://dev.bukkit.org/projects/worldedit)
---
## Usage
```zsh
git clone https://github.com/clxrityy/test-craft.git && cd test-craft
```
- [With npm](#using-packagejson-scripts)
- [With Docker CLI](#manually)
### Using `package.json` scripts:
> Works with `npm`, `pnpm` and `yarn`.
> Examples will include usage with `pnpm`.
- Firstly, run the `chmod` script to ensure all scripts can be executable:
```zsh
npm run chmod
```
```zsh
pnpm chmod
```
```zsh
yarn run chmod
```
#### Start the server
```zsh
pnpm start
```
##### In watch mode
```zsh
pnpm start:watch
```
#### Stop the server
```zsh
pnpm stop
```
### Manually
> With [docker](https://www.docker.com/) CLI
#### Start the server
```zsh
docker compose up -d
```
##### In watch mode
```zsh
docker compose up -w
```
#### Stop the server
```zsh
docker compose down
```
#### Restart the server
```zsh
docker restart
```