Skip to content

Commit c824843

Browse files
ThnksCJThnksCJ
committed
woah im actually doing stuff now
Took 17 minutes
1 parent bcbe8da commit c824843

File tree

10 files changed

+231
-30
lines changed

10 files changed

+231
-30
lines changed

‎docs/.vitepress/config.mts‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,10 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
6666
]
6767
},
6868
{
69-
text: 'Getting Help', link: 'help/', //will have info about help related things; opening help ticket, emailing, etc
69+
text: 'Help', //will have info about help related things; opening help ticket, emailing, etc
7070
collapsed: false,
7171
items: [
72+
{ text: 'Getting Help', link: 'help/' },
7273
{ text: 'HWID', link: 'help/hwid' }
7374
]
7475
}
@@ -85,7 +86,7 @@ function sidebarFeatures(): DefaultTheme.SidebarItem[] {
8586
text: 'Client',
8687
collapsed: false,
8788
items: [
88-
{ text: 'ClickGUI', link: 'modules/client/clickgui' } //just an example, in future this should be automatically generated
89+
{ text: 'ClickGUI', link: 'modules/features/clickgui' } //just an example, in future this should be automatically generated
8990
]
9091
},
9192
{
@@ -124,14 +125,22 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
124125
text: 'Information',
125126
collapsed: false,
126127
items: [
127-
{ text: 'Getting Started', link: 'guide/getting-started' }
128+
{ text: 'Getting Started', link: 'index' }
128129
]
129130
},
130131
{
131-
text: 'Client',
132+
text: 'org.rusherhack.client.api',
132133
collapsed: true,
133134
items: [
134-
{ text: 'Globals', link: 'features/globals' }
135+
{ text: 'Globals', link: 'features/globals' },
136+
{ text: 'IRusherHack', link: 'features/irusherhack' },
137+
{
138+
text: 'utils',
139+
collapsed: true,
140+
items: [
141+
{ text: 'BufferUtils', link: 'features/bufferutils' },
142+
]
143+
}
135144
]
136145
},
137146
{

‎docs/api/client/globals.md‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎docs/api/client/irusherhack.md‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎docs/api/features/globals.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
org.rusherhack.client.api.Globals
2+
3+
# Globals
4+
5+
```java
6+
public interface Globals {
7+
Minecraft mc = Minecraft.getInstance();
8+
}
9+
```
10+
11+
---
12+
13+
### Fields
14+
15+
---
16+
17+
#### `mc`
18+
19+
- **Type:** `Minecraft`
20+
- **Description:** The Minecraft instance

‎docs/api/features/irusherhack.md‎

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
org.rusherhack.client.api.IRusherHack
2+
3+
# IRusherHack
4+
5+
```java
6+
public interface IRusherHack {
7+
IEventBus getEventBus();
8+
IFeatureManager<IModule> getModuleManager();
9+
ICommandManager getCommandManager();
10+
IHudManager getHudManager();
11+
IWindowManager getWindowManager();
12+
IThemeManager getThemeManager();
13+
IBindManager getBindManager();
14+
IRelationManager getRelationManager();
15+
IRotationManager getRotationManager();
16+
INotificationManager getNotificationManager();
17+
IChunkProcessor getChunkProcessor();
18+
IServerState getServerState();
19+
IInteractions interactions();
20+
ILogger createLogger(String name);
21+
String getVersion();
22+
Path getConfigPath();
23+
IRenderer2D getRenderer2D();
24+
IRenderer3D getRenderer3D();
25+
Fonts fonts();
26+
Colors colors();
27+
Entities entities();
28+
}
29+
```
30+
31+
---
32+
33+
### Methods
34+
35+
---
36+
37+
#### `getEventBus`
38+
39+
- **Type:** [`IEventBus`]()
40+
- **Description:** Returns the event bus instance
41+
42+
### `getModuleManager`
43+
44+
- **Type:** [`IFeatureManager<IModule>`]()
45+
- **Description:** Returns the module manager instance
46+
47+
### `getCommandManager`
48+
49+
- **Type:** [`ICommandManager`]()
50+
- **Description:** Returns the command manager instance
51+
52+
### `getHudManager`
53+
54+
- **Type:** [`IHudManager`]()
55+
- **Description:** Returns the HUD manager instance
56+
57+
### `getWindowManager`
58+
59+
- **Type:** [`IWindowManager`]()
60+
- **Description:** Returns the window manager instance
61+
62+
### `getThemeManager`
63+
64+
- **Type:** [`IThemeManager`]()
65+
- **Description:** Returns the theme manager instance
66+
67+
### `getBindManager`
68+
69+
- **Type:** [`IBindManager`]()
70+
- **Description:** Returns the bind manager instance
71+
72+
### `getRelationManager`
73+
74+
- **Type:** [`IRelationManager`]()
75+
- **Description:** Returns the relation manager instance
76+
77+
### `getRotationManager`
78+
79+
- **Type:** [`IRotationManager`]()
80+
- **Description:** Returns the rotation manager instance
81+
82+
### `getNotificationManager`
83+
84+
- **Type:** [`INotificationManager`]()
85+
- **Description:** Returns the notification manager instance
86+
87+
### `getChunkProcessor`
88+
89+
- **Type:** [`IChunkProcessor`]()
90+
- **Description:** Returns the chunk processor instance
91+
92+
### `getServerState`
93+
94+
- **Type:** [`IServerState`]()
95+
- **Description:** Returns the server state instance
96+
97+
### `interactions`
98+
99+
- **Type:** [`IInteractions`]()
100+
- **Description:** Returns the interactions instance
101+
102+
### `createLogger`
103+
104+
- **Type:** [`ILogger`]()
105+
- **Description:** Creates a new logger with the specified name
106+
- **Parameters:**
107+
108+
| Type | Name | Description |
109+
|----------|--------|------------------------|
110+
| `String` | `name` | The name of the logger |
111+
112+
- **Usage:**
113+
```java
114+
ILogger logger = RusherHackAPI.createLogger("My Plugin");
115+
116+
logger.info("Hello, world!");
117+
logger.warn("This is a warning!");
118+
logger.error("This is an error!");
119+
logger.debug("This is a debug message!");
120+
```
121+
- **See:** [org.rusherhack.core.logging.Logger]() & [org.rusherhack.core.logging.ILogger]()
122+
123+
### `getVersion`
124+
125+
- **Type:** `String`
126+
- **Description:** Returns the version of the client
127+
128+
### `getConfigPath`
129+
130+
- **Type:** `Path`
131+
- **Description:** Returns the path to the configuration directory
132+
133+
### `getRenderer2D`
134+
135+
- **Type:** [`IRenderer2D`]()
136+
- **Description:** Returns the 2D renderer instance
137+
138+
### `getRenderer3D`
139+
140+
- **Type:** [`IRenderer3D`]()
141+
- **Description:** Returns the 3D renderer instance
142+
143+
### `fonts`
144+
145+
- **Type:** [`Fonts`]()
146+
- **Description:** Contains methods for accessing general font renderer instances
147+
- **See:** [Fonts](#fonts)
148+
149+
### `colors`
150+
151+
- **Type:** [`Colors`]()
152+
- **Description:** Allows access to the user's color preferences, as well as entities most prominent color
153+
- **See:** [Colors](#colors)
154+
155+
### `entities`
156+
157+
- **Type:** [`Entities`]()
158+
- **Description:** Contains methods for determining the type of an entity
159+
- **See:** [Entities](#entities)
160+
161+
---

‎docs/api/guide/getting-started.md‎ renamed to ‎docs/api/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ called `plugins` in the `.minecraft/rusherhack` folder, and drop plugin .jar fil
1313

1414
- [Java](https://nodejs.org/) version 17 or higher.
1515
- An ide or text editor. Below are some recommended ones:
16-
- [IntelliJ IDEA](https://www.jetbrains.com/idea/)
17-
- [VSCode](https://code.visualstudio.com/)
16+
- [IntelliJ IDEA](https://www.jetbrains.com/idea/)
17+
- [VSCode](https://code.visualstudio.com/)
1818

1919
::: code-group
2020

‎docs/guide/help/hwid.md‎

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,27 @@
1-
under construction
1+
# HWID
22

3-
todo:
4-
- explain what hwid is and rusherhack is linked to computer
5-
- possible to have two hwids linked to one account
3+
This page will explain what HWID is, why, and how it is used within RusherHack.
4+
5+
## **What is HWID (Hardware ID)?**
6+
7+
HWID stands for Hardware ID, which is a unique identifier tied to your computer.
8+
It is used by us, to uniquely identify and verify that your account isn't being used on
9+
someone else's computer. The HWID is generated based on over several
10+
hardware components to create a unique identifier for your system.
11+
Since each computer's hardware setup is different, the resulting HWID is
12+
unique to that specific machine.
13+
14+
We employ a HWID-based licensing or security model that can tie an account or license to a
15+
particular computer, making it more difficult to share or transfer accounts between people (Known as account sharing which
16+
is against the ToS).
17+
18+
HWIDs are primarily used for:
19+
20+
- Preventing unauthorized access (e.g., stopping RusherHack from being reused on multiple computers)
21+
- Enforcing single-user licenses to prevent account sharing
22+
23+
## **A second HWID**
24+
25+
RusherHack does allow multiple (max of 2) computers to be used under the same license
26+
if certain conditions are met, if you need to use more than 2 computers,
27+
you will need to purchase an additional license.

‎docs/guide/help/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
Having an issue with RusherHack? Reach out to the support team and we will try our best to assist you!
1+
Having an issue with RusherHack? Reach out to the support team, and we will try our best to assist you!
22

33
Different methods of getting help:
44
- Discord
55
- To get access to the RusherHack Discord server, you must link your account in the [installer](../introduction/installation)
6-
- #support-and-hwid channel
6+
- `#support-and-hwid` channel
77
- Email [email protected]
88
- Direct contact with the developer
99
- Usually responds in under 24 hours

‎docs/guide/index.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Welcome to the official documentation for RusherHack!
2+
3+
It was created to support the documentation needs of
4+
RusherHacks plugin system, however, it can be used for
5+
finding out general information about RusherHack and its features.

‎package-lock.json‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)