Skip to content

Commit e7336b2

Browse files
committed
Updated readme.md and documentation.
Signed-off-by: Pavel Erokhin (MairwunNx) <MairwunNx@gmail.com>
1 parent 1ce40e4 commit e7336b2

File tree

7 files changed

+102
-101
lines changed

7 files changed

+102
-101
lines changed

assets/core_social_logo.svg

Lines changed: 29 additions & 0 deletions
Loading

assets/core_social_logo.xd

3.88 MB
Binary file not shown.

assets/support_social.svg

Lines changed: 18 additions & 0 deletions
Loading

assets/support_social.xd

162 KB
Binary file not shown.

documentation/in-using.md renamed to documentation/for-developers.md

Lines changed: 24 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,22 @@
11
> ## Documentation for basic use of the CoreAPI.
22
3-
## 1. For playing and running Minecraft:
3+
### Getting Core API as dependency
44

5-
#### 1.1 Download Core API mod module.
5+
```groovy
6+
repositories {
7+
maven { url("https://jitpack.io") }
8+
}
69
7-
Visit **Core API** repository on github, visit **releases** tab and download the `.jar` files of latest _pre-release_ / release (**recommended**)
8-
9-
Releases page: https://github.com/ProjectEssentials/ProjectEssentials-Core/releases
10-
11-
#### 1.2 Install Core API modification.
12-
13-
The minecraft forge folder structure below will help you understand what is written below.
14-
15-
```
16-
.
17-
├── assets
18-
├── config
19-
├── libraries
20-
├── mods (that's how it should be)
21-
│ └── Project Essentials Core-MOD-1.14.4-1.X.X.X.jar
22-
└── ...
10+
dependencies {
11+
compile(
12+
group: "com.github.projectessentials",
13+
name: "ProjectEssentials-Core",
14+
version: "v1.14.4-1.0.3.1"
15+
)
16+
}
2317
```
2418

25-
Place your mods and Core API mods according to the structure above.
26-
27-
#### 1.3 Verifying mod on the correct installation.
28-
29-
Run the game, check the number of mods, if the list of mods contains `Project Essentials Core` mod, then the mod has successfully passed the initialization of the modification.
30-
31-
## 2. For developers:
32-
33-
### 2.1 Getting started with installing.
34-
35-
To get the Core API source for development and interactions with the rights of players, you need to get the dependencies and get the documentation to view it in your IDE.
36-
37-
Installation documentation is located in the readme file (or just follow the link): https://github.com/ProjectEssentials/ProjectEssentials-Core#-install-using-gradle
38-
39-
### 2.2 API usage.
40-
41-
I could not write this damn documentation at all and spend time on it, because it is so fucking understandable. But just in case, I will nevertheless sign here some trifles.
42-
43-
Let's start small?
44-
45-
#### 2.2.1 Functions.
19+
### API Functions
4620

4721
```
4822
EssBase.logBaseInfo
@@ -56,7 +30,7 @@ EssBase.validateForgeVersion
5630
- description: Validate forge version on compatibility with loaded mod. If validation failed, then you will be notified with messages in logger with level WARN.
5731
```
5832

59-
#### 2.2.2 Extensions.
33+
### API Extensions
6034

6135
```
6236
CommandContext<CommandSource>.isPlayerSender
@@ -122,7 +96,7 @@ String.Companion.empty
12296
- return: empty string. (string)
12397
```
12498

125-
#### 2.2.3 Helpers.
99+
### API Helpers.
126100

127101
```
128102
ForgePathHelper.getRootPath
@@ -153,6 +127,14 @@ ModPathHelper.MOD_CONFIG_FOLDER
153127
- description: Project Essentials mod config folder.
154128
```
155129

156-
## These are all API methods, I hope you find everything simple to use.
130+
### Dependencies using by Core API.
131+
132+
```
133+
- kotlin-std lib version: 1.3.61
134+
- kotlinx serialization version: 0.14.0
135+
- forge version: 1.14.4-28.1.114
136+
- brigadier version: 1.0.17
137+
- target jvm version: 1.8
138+
```
157139

158140
### If you have any questions or encounter a problem, be sure to open an issue!

documentation/for-players.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
> ## Installation instructions.
2+
3+
For start the modification, you need installed Forge, it is desirable that the version matches the supported versions. You can download Forge from the [link](https://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.14.4.html).
4+
Move the downloaded mod (marked `-MOD` in the file name) to the `mods` folder (installation example below).
5+
6+
```
7+
.
8+
├── assets
9+
├── config
10+
├── libraries
11+
├── mods (that's how it should be)
12+
│ └── Project Essentials Core-MOD-1.14.4-1.X.X.X.jar
13+
└── ...
14+
```
15+
16+
Now try to start the game, go to the `mods` tab, if this modification is displayed in the `mods` tab, then the mod has been successfully installed.
17+
18+
### If you have any questions or encounter a problem, be sure to open an [issue](https://github.com/ProjectEssentials/ProjectEssentials-Core/issues/new/choose)!

readme.md

Lines changed: 13 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,23 @@
1-
## Project Essentials: CoreAPI
1+
## Project Essentials Core: core mod for all modules of Project Essentials.
22

3-
[![](https://jitpack.io/v/projectessentials/ProjectEssentials-Core.svg)](https://jitpack.io/#projectessentials/ProjectEssentials-Core)
4-
![GitHub](https://img.shields.io/github/license/ProjectEssentials/ProjectEssentials-Core)
3+
<img src="./assets/core_social_logo.svg">
54

6-
> ## CoreAPI for Project Essentials mods.
5+
### What is it
76

8-
#### ❗ Compatibility with forge version `28.0.X` and `28.1.X`.
7+
This is the base module (core) for all other Project Essentials modules. It contains the necessary dependencies that are used in other modules, for example Kotlin std lib and Kotlinx Serialization and Brigadier, this core also contains common code, for example, the initialization process and some extensions of existing forge classes, which can be useful and can reduce duplicate code. For developers, all the information is in the [documentation](documentation/for-developers.md).
98

10-
## 🧐 Install using Gradle (for developers):
11-
> ##### If your project uses Gradle as Build Tool, then use the code below to add dependencies:
9+
### Last steps
1210

13-
```groovy
14-
repositories {
15-
maven { url("https://jitpack.io") }
16-
}
11+
#### [Download mod](https://github.com/ProjectEssentials/ProjectEssentials-Core/releases/download/v1.14.4-1.0.3.0/ProjectEssentials-Core-MOD-1.14.4-1.0.3.0.jar) · [Download API](https://github.com/ProjectEssentials/ProjectEssentials-Core/releases/download/v1.14.4-1.0.3.0/ProjectEssentials-Core-API-1.14.4-1.0.3.0.jar) · [How to install](documentation/for-players.md) · [Troubleshooting](https://github.com/ProjectEssentials/ProjectEssentials-Core/issues/new/choose) · [News & updates](https://t.me/minecraftforge)
1712

18-
dependencies {
19-
compile(
20-
group: "com.github.projectessentials",
21-
name: "ProjectEssentials-Core",
22-
version: "v1.14.4-1.0.3.1"
23-
)
24-
}
25-
```
13+
<a href="https://ko-fi.com/mairwunnx" target="_blank"><img src="./assets/support_social.svg"></a>
2614

27-
## 🤔 Install using Maven (for developers):
28-
> ##### If your project uses Maven as Build Tool, then use the code below to add dependencies:
15+
### Compatibility
2916

30-
```xml
31-
<repositories>
32-
<repository>
33-
<id>jitpack.io</id>
34-
<url>https://jitpack.io</url>
35-
</repository>
36-
</repositories>
17+
Currently mod branch supported forge version `28.0.X` and `28.1.X` (Minecraft `1.14.4`).
3718

38-
<dependency>
39-
<groupId>com.github.projectessentials</groupId>
40-
<artifactId>ProjectEssentials-Core</artifactId>
41-
<version>v1.14.4-1.0.3.1</version>
42-
</dependency>
43-
```
19+
### Credits
4420

45-
## 🎮 Installation instructions (for playing):
46-
> ##### Just move Project Essentials Core-1.14.4-1.X.X.X.jar to mods directory:
47-
48-
```
49-
.
50-
├── assets
51-
├── config
52-
├── libraries
53-
├── mods (that's how it should be)
54-
│ └── Project Essentials Core-MOD-1.14.4-1.X.X.X.jar.
55-
└── ...
56-
```
57-
58-
```
59-
Additional information:
60-
- kotlin-std lib version: 1.3.60
61-
- kotlinx serialization version: 0.14.0
62-
- target jvm version: 1.8
63-
```
64-
65-
### After you got the dependencies and the library itself:
66-
67-
# [Read the documentation to get started!](./documentation/in-using.md)
68-
69-
> ## Made with 💕 by [MairwunNx](https://mairwunnx.github.io/)
21+
- Author: Pavel Erokhin [@mairwunnx](https://github.com/mairwunnx)
22+
- JetBrains Licenses: [JetBrains](https://www.jetbrains.com/)
23+
- Inspired by: [EssentialsX](https://github.com/EssentialsX)

0 commit comments

Comments
 (0)