Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Snowiiii committed Jan 1, 2025
1 parent 9aa13c5 commit 207ed1c
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 16 deletions.
3 changes: 0 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,6 @@ There are several ways you can contribute to Pumpkin:
Ensure your code adheres to our project structure and style guidelines.
Write clear and concise commit messages that describe your changes.

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

### Additional Information

We encourage you to comment on existing issues and pull requests to share your thoughts and provide feedback.
Expand Down
12 changes: 8 additions & 4 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,14 @@ export default defineConfig({
items: [
{ text: "Contributing", link: "/developer/contributing" },
{ text: "Introduction", link: "/developer/introduction" },
{ text: "Networking", link: "/developer/networking" },
{
text: "Authentication",
link: "/developer/authentication",
text: "Networking",
link: "/developer/networking/networking",
items: [
{ text: "Authentication", link: "/developer/networking/authentication" },
{ text: "RCON", link: "/developer/networking/rcon" },
]
},
{ text: "RCON", link: "/developer/rcon" },
{ text: "World", link: "developer/world" },
],
},
Expand Down Expand Up @@ -99,6 +101,8 @@ export default defineConfig({
["link", { rel: "apple-touch-icon", href: "/assets/apple-touch-icon.png", sizes: "180x180" }],
["link", { rel: "manifest", href: "/assets/site.webmanifest" }],

["link", { rel: "canonical", href: "https://pumpkinmc.org/" }],

["meta", { name: "apple-mobile-web-app-title", content: "Pumpkin" }],
["meta", { name: "keywords", content: "minecraft, performance, pumpkin, rust, server" }],
],
Expand Down
2 changes: 1 addition & 1 deletion docs/about/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ and customizable experience. It prioritizes performance and player enjoyment whi
<source srcset="/assets/introduction-preview-2560x1440.png" media="(min-width: 2560px)">
<source srcset="/assets/introduction-preview-1280x720.png" media="(min-width: 1280px)">
<source srcset="/assets/introduction-preview-640x360.png" media="(min-width: 640px)">
<img src="/assets/introduction-preview-1280x720.png" alt="Preview">
<img src="/assets/introduction-preview-1280x720.png" alt="introduction-preview">
</picture>

## What Pumpkin wants to achieve
Expand Down
2 changes: 1 addition & 1 deletion docs/about/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Pre-release: Currently under development and not yet ready for official release.

To get Pumpkin running, you first have to clone it:
```shell
git clone https://github.com/Snowiiii/Pumpkin.git
git clone https://github.com/Pumpkin-MC/Pumpkin.git
cd Pumpkin
```

Expand Down
16 changes: 13 additions & 3 deletions docs/developer/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ There are several ways you can contribute to Pumpkin:
#### Contributing Code
To get started with contributing code to Pumpkin, fork the repository on github

- First create a github account if you don't already have one
1. First create a github account if you don't already have one

- Go to Pumpkin's Official [Github Repository](https://github.com/Snowiiii/Pumpkin) and press fork
2. Go to Pumpkin's Official [Github Organization](https://github.com/Pumpkin-MC) and press fork

> Creating a fork means you now have your own copy of the Pumpkin source code, (this does not mean you own the copyright)
Now that you have a copy that you can edit, you will need a few tools

- Install [git](https://git-scm.com/downloads) for your operating system
3. Install [git](https://git-scm.com/downloads) for your operating system

- To get started with git, visit [Getting started with Git](https://docs.github.com/en/get-started/getting-started-with-git)

Expand All @@ -45,6 +45,16 @@ There are several ways you can contribute to Pumpkin:

- If you are wanting to contribute to documentation, install [NodeJS](https://nodejs.org/en)

### Getting the Minecraft source code
When working at Pumpkin, we heavily rely on the official Minecraft client and utilize existing server logic. We often refer to the official Minecraft source code.
The easiest way to get the Minecraft source code is using Fabric Yarn. Make sure you have Gradle installed before running the following commands:
```
git clone https://github.com/FabricMC/yarn.git
cd yarn
./gradlew decompileVineflower
```
After decompiling, you can find the source code located in `build/namedSrc`.

### Additional Information
We encourage you to comment on existing issues and pull requests to share your thoughts and provide feedback.

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### Networking

Most of the Networking code in Pumpkin can be found at [Pumpkin-Protocol](https://github.com/Snowiiii/Pumpkin/tree/master/pumpkin-protocol)
Most of the Networking code in Pumpkin can be found at [Pumpkin-Protocol](https://github.com/Pumpkin-MC/Pumpkin/tree/master/pumpkin-protocol)

Serverbound: Client→Server

Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 207ed1c

Please sign in to comment.