Skip to content

Commit

Permalink
docs: Overhaul
Browse files Browse the repository at this point in the history
  • Loading branch information
Snowiiii committed Oct 12, 2024
1 parent 5d86ba5 commit d8220bf
Show file tree
Hide file tree
Showing 18 changed files with 2,558 additions and 317 deletions.
5 changes: 2 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,8 @@ And in release:
cargo run --no-default-features --release
```

### Project Structure

Before contributing, it would be helpful to get to know the project structure, for further information, visit [STRUCTURE.md](STRUCTURE.md)
### Docs
The Documentation of Pumpkin can be found at https://snowiiii.github.io/Pumpkin/

### Additional Information

Expand Down
49 changes: 8 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

</div>

Pumpkin is a Minecraft server built entirely in Rust, offering a fast, efficient,
[Pumpkin](https://snowiiii.github.io/Pumpkin/) is a Minecraft server built entirely in Rust, offering a fast, efficient,
and customizable experience. It prioritizes performance and player enjoyment while adhering to the core mechanics of the game.

![image](https://github.com/user-attachments/assets/7e2e865e-b150-4675-a2d5-b52f9900378e)
Expand Down Expand Up @@ -73,55 +73,22 @@ and customizable experience. It prioritizes performance and player enjoyment whi
Check out our [Github Project](https://github.com/users/Snowiiii/projects/12/views/3) to see current progress

## How to run

There are currently no release builds, because there was no release :D.

To get Pumpkin running you first have to clone it:

```shell
git clone https://github.com/Snowiiii/Pumpkin.git
cd Pumpkin
```

You also may have to [install rust](https://www.rust-lang.org/tools/install) when you don't already have.

You can place a vanilla world into the Pumpkin/ directory when you want. Just name the World to `world`

Then run:

> [!NOTE]
> This can take a while. Because we enabled heavy optimizations for release builds
>
> To apply further optimizations specfic to your CPU and use your CPU features. You should set the target-cpu=native
> Rust flag.
```shell
cargo run --release
```

### Docker

Experimental Docker support is available.
The image is currently not published anywhere, but you can use the following command to build it:

```shell
docker build . -t pumpkin
```

To run it use the following command:

```shell
docker run --rm -p 25565:25565 -v "./world:/pumpkin/world" pumpkin
```
See https://snowiiii.github.io/Pumpkin/about/quick-start.html

## Contributions

Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md)

## Docs
The Documentation of Pumpkin can be found at https://snowiiii.github.io/Pumpkin/

## Communication

Consider joining our [discord](https://discord.gg/wT8XjrjKkf) to stay up-to-date on events, updates, and connect with other members.

## Funding
If you want to fund my and help the project, Check out my [GitHub sponsors](https://github.com/sponsors/Snowiiii)

## Thanks

A big thanks to [wiki.vg](https://wiki.vg/) for providing valuable information used in the development of this project.
17 changes: 0 additions & 17 deletions STRUCTURE.md

This file was deleted.

38 changes: 32 additions & 6 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,36 @@ export default defineConfig({
base: "/Pumpkin/",
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
search: {
provider: "local",
},
sidebar: [
{
text: "About",
items: [
{ text: "Introduction", link: "/about/introduction" },
{ text: "Quick Start", link: "/about/quick-start" },
],
},
{
text: "Developers",
items: [
{
text: "Contributing",
link: "https://github.com/Snowiiii/Pumpkin/blob/master/CONTRIBUTING.md",
},
{ text: "Introduction", link: "/developer/introduction" },
{ text: "Networking", link: "/developer/networking" },
{ text: "Authentication", link: "/developer/authentication" },
],
},

{
text: "Plugins",
text: "Configuration",
items: [
{ text: "About Plugins", link: "/plugins/about" },
{
text: "Getting Started in Rust",
link: "/plugins/getting-started-rs",
},
{ text: "Introduction", link: "/config/introduction" },
{ text: "Basic", link: "/config/basic" },
{ text: "Advanced", link: "/config/advanced" },
],
},
],
Expand All @@ -39,6 +49,22 @@ export default defineConfig({
],

logo: "/assets/icon.png",
footer: {
message: "Released under the MIT License.",
copyright: "Copyright © 2024-present Aleksandr Medvedev",
},
editLink: {
pattern: "https://github.com/Snowiiii/Pumpkin/blob/master/docs/:path",
text: "Edit this page on GitHub",
},
lastUpdated: {
text: "Updated at",
formatOptions: {
dateStyle: "medium",
timeStyle: "medium",
},
},
outline: "deep"
},
head: [["link", { rel: "icon", href: "/assets/favicon.ico" }]],
});
Loading

0 comments on commit d8220bf

Please sign in to comment.