Skip to content

Commit

Permalink
Workflow: Don't deploy on PR's
Browse files Browse the repository at this point in the history
  • Loading branch information
Snowiiii committed Feb 6, 2025
1 parent 4ca5b33 commit 0dee6c2
Show file tree
Hide file tree
Showing 8 changed files with 245 additions and 245 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name: Deploy VitePress site to GitHub Pages

on:
push:
branches: [master]
pull_request:
workflow_dispatch:

Expand Down Expand Up @@ -49,6 +50,7 @@ jobs:
needs: build
runs-on: ubuntu-latest
name: Deploy
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
steps:
- name: Deploy to GitHub Pages
id: deployment
Expand Down
3 changes: 1 addition & 2 deletions docs/about/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,9 @@ and customizable experience. It prioritizes performance and player enjoyment whi
## What Pumpkin will not

- Be compatible with plugins or mods for other servers
- Function as a framework for building a server from scratch.

> [!IMPORTANT]
> Pumpkin is currently under heavy development. Check out our [Github Project](https://github.com/users/Snowiiii/projects/12/views/3) to see current progress
> Pumpkin is currently under heavy development. Check out our [Github Project](https://github.com/orgs/Pumpkin-MC/projects/3) to see current progress
## Vanilla

Expand Down
12 changes: 6 additions & 6 deletions docs/developer/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ There are several ways you can contribute to Pumpkin:
Describe the proposed feature in detail, including its benefits and potential implementation considerations.

#### Contributing Code
To get started with contributing code to Pumpkin, fork the repository on github
To get started with contributing code to Pumpkin, fork the repository on GitHub

1. 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

2. Go to Pumpkin's Official [Github Organization](https://github.com/Pumpkin-MC) 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)
Expand All @@ -35,11 +35,11 @@ There are several ways you can contribute to Pumpkin:

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

- Optional: If you want a graphical tool to interact with Github, install [Github-Desktop](https://desktop.github.com/download/)
- Optional: If you want a graphical tool to interact with GitHub, install [GitHub-Desktop](https://desktop.github.com/download/)

> Github Desktop may be easier if you are not used to the command line, but it is not for everyone
> GitHub Desktop may be easier if you are not used to the command line, but it is not for everyone
- To get started with Github Desktop, visit [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/overview/getting-started-with-github-desktop)
- To get started with GitHub Desktop, visit [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/overview/getting-started-with-github-desktop)

- If you are wanting to contribute code, install Rust at [rust-lang.org](https://www.rust-lang.org/).

Expand Down
4 changes: 2 additions & 2 deletions docs/developer/mobile.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,12 @@ Press `i` if you in normal mode.
Press esc, when type `:q!`` if you dont want save edited data, or `:wq` if want.

## Where i can learn how use this editor?
Type `hx --tutor` or go to offical website.
Type `hx --tutor` or go to official website.

## Why not use vscode?
1) Vscode is hard to setup, by the way its works only on web with limited functional.
2) Rust analyzer dont work on it, maybe emulator can hep with it, but its slow down code compilation.
3) Vscode not good for android devices, because its higly desirable to have a mouse, while in helix you need only keyboard.
3) Vscode not good for android devices, because its highly desirable to have a mouse, while in helix you need only keyboard.
4) Vscode laggy on some devices.

## Why its so hard to type?
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/world.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ file, and allowing that file to be loaded into multiple instances.

The files stored in this format are .slime files.

More details can be found on the github page for [Slime World Manager](https://github.com/cijaaimee/Slime-World-Manager#:~:text=Slime%20World%20Manager%20is%20a,worlds%20faster%20and%20save%20space.), as well as on [Dev Blog #5](https://hypixel.net/threads/dev-blog-5-storing-your-skyblock-island.2190753/) for Hypixel.
More details can be found on the GitHub page for [Slime World Manager](https://github.com/cijaaimee/Slime-World-Manager#:~:text=Slime%20World%20Manager%20is%20a,worlds%20faster%20and%20save%20space.), as well as on [Dev Blog #5](https://hypixel.net/threads/dev-blog-5-storing-your-skyblock-island.2190753/) for Hypixel.

#### Schematic File Format

Expand Down
2 changes: 1 addition & 1 deletion docs/plugin-dev/example-plugin/basic-logic.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ This method gets a mutable reference to itself (in this case the `MyPlugin` stru
```rs
fn get_data_folder() -> String
```
Returns the path to a folder dedicated to this plugin, which should be used for persistant data storage
Returns the path to a folder dedicated to this plugin, which should be used for persistent data storage
```rs
async fn get_player_by_name(player_name: String) -> Option<Arc<Player>>
```
Expand Down
4 changes: 2 additions & 2 deletions docs/plugin-dev/example-plugin/join-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ As you can see, the `PlayerJoinEvent` exposes two methods. But since it inherits
Individual event handlers are just structs which implement the `EventHandler<T>` trait (where T is a specific event implementation).

### What are blocking events?
The Pumpkin Plugin Event System differentiates between two types of evetns: blocking and non-blocking. Each have their benefits:
The Pumpkin Plugin Event System differentiates between two types of events: blocking and non-blocking. Each have their benefits:
#### Blocking events
```diff
+ Can modify the event (like editing the join message)
Expand Down Expand Up @@ -74,7 +74,7 @@ impl EventHandler<PlayerJoinEventImpl> for MyJoinHandler {

**Explanation**:
- `struct MyJoinHandler;`: The struct for our event handler
- `#[with_runtime(global)]`: Pumpkin uses the tokio async runtime, which acts in wierd ways across the plugin boundary. Even though it is not necessary in this specific example, it is a good practise to wrap all async `impl`s that interact with async code with this macro.
- `#[with_runtime(global)]`: Pumpkin uses the tokio async runtime, which acts in weird ways across the plugin boundary. Even though it is not necessary in this specific example, it is a good practice to wrap all async `impl`s that interact with async code with this macro.
- `#[async_trait]`: Rust doesn't have native support for traits with async methods. So we use the `async_trait` crate to allow this.
- `async fn handle_blocking()`: Since we chose for this event to be blocking, it is necessary to implement the `handle_blocking()` method instead of the `handle()` method.

Expand Down
Loading

0 comments on commit 0dee6c2

Please sign in to comment.