-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
km127pl
committed
Aug 10, 2023
1 parent
d3bf4ef
commit 0141cf3
Showing
1 changed file
with
38 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,45 @@ | ||
# ArchCraft | ||
# arciera/server | ||
|
||
ArchCraft is a minimalistic, modular, and lightweight Minecraft server written in TypeScript and powered by Node.js. | ||
[![Node.js CI](https://github.com/arciera/server/actions/workflows/nodejs.yml/badge.svg)](https://github.com/arciera/server/actions/workflows/nodejs.yml) | ||
|
||
## Features | ||
[**`Download`**](https://github.com/arciera/server/releases/latest) · [**`Documentation`**](https://github.com/ariera/server/wiki) | ||
|
||
- **Minimalistic Design:** ArchCraft is designed with simplicity in mind, focusing on essential features to run a Minecraft server. | ||
- **Modularity:** The server is built with a modular architecture, making it easy to add or remove features as needed. | ||
- **Lightweight:** ArchCraft is optimized for performance, ensuring efficient resource utilization. | ||
- **Customizability:** Server administrators can customize various aspects of the server to tailor the gameplay experience. | ||
- **Small Footprint:** The server is small in size, using zero external dependencies. | ||
A Minecraft server written in TypeScript. Modern, multi-threaded, modular and built for performance. | ||
|
||
## Requirements | ||
- Node.js v18 or higher | ||
- npm v8 or higher | ||
## Running | ||
|
||
## Getting Started | ||
To run arciera/server you need [**Node.js 18 or higher**](https://nodejs.org/en/download). | ||
|
||
To run ArchCraft on your machine, follow these steps: | ||
Download `server.mjs` from the [latest release](https://github.com/arciera/server/releases/latest). Alternatively, you | ||
can clone the repository and run `npm run bundle` to build the server yourself. You will find the bundled server | ||
in `build/index.js`. | ||
|
||
1. Clone the ArchCraft repository `git clone https://github.com/zefir-git/archcraft.git` | ||
2. Install dependencies `npm install` | ||
3. Configure your server settings in `config.json`. | ||
4. Start the server `npm build:start` | ||
To start the server: | ||
|
||
```shell | ||
node server.mjs | ||
``` | ||
|
||
To stop the server, send `SIGINT` by pressing <kbd>Ctrl</kbd>+<kbd>C</kbd> (`^C`). | ||
|
||
## Issues | ||
|
||
If you find any bugs or issues, or have any suggestions, please [open an issue](https://github.com/arciera/server/issues/new). | ||
|
||
Fixing bugs is our utmost priority. | ||
|
||
## FAQ | ||
|
||
<details> | ||
<summary>I can't join the world!</summary> | ||
|
||
> Arciera server is a bare-bones server and does not have a world. If you want to connect to a world, you need to use a plugin that provides a world. Any additional features beyond simply establishing a connection require a plugin. | ||
</details> | ||
## Contributing | ||
|
||
All contributions are most welcome! | ||
|
||
If you would like to contribute a new feature, make sure that it is within the scope of the project. Arciera server aims to be minimal and lightweight and sometimes creating a plugin might be more suitable. | ||
|
||
To contribute, [fork the repository](https://github.com/arciera/server/fork), make your changes and open a pull request. |