Skip to content

Commit 99e0961

Browse files
committed
pre-update v1 for 3.0
1 parent a79f684 commit 99e0961

File tree

9 files changed

+326
-226
lines changed

9 files changed

+326
-226
lines changed

docs/.vitepress/config.mts

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@ export default defineConfig({
2424
sidebar: [
2525
{ text: 'Getting Started',
2626
items: [
27-
{ text: 'Setting Up', link: 'getting-started/setting-up' }
28-
// { text: 'New Pack', link: 'getting-started/new-pack' }
29-
// { text: 'New Category', link: 'getting-started/new-category' }
27+
{ text: 'Setting Up', link: 'getting-started/setting-up' },
28+
{ text: 'Creating a New Pack', link: 'new/new-pack' },
29+
{ text: 'Creating a New Category', link: 'new/new-category' },
30+
{ text: 'Now what?', link: 'getting-started/afterwards' }
3031
]
3132
},
3233
{
@@ -36,13 +37,6 @@ export default defineConfig({
3637
// { text: 'JS Files', link: 'scripts/js-files' }
3738
]
3839
},
39-
{
40-
text: 'JSONs',
41-
items: [
42-
{ text: 'Other JSONs', link: 'jsons/other-jsons' },
43-
{ text: 'Pack JSONs', link: 'jsons/pack-jsons' }
44-
]
45-
},
4640
{
4741
text: 'Misc',
4842
items: [

docs/.vitepress/theme/style.css

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,4 +216,24 @@
216216
}
217217
.VPSidebar {
218218
padding-bottom: 16px !important;
219+
}
220+
221+
.unnecessary-codeblock,
222+
kbd {
223+
background-color: var(--vp-code-block-bg);
224+
padding: 5px 10px;
225+
width: fit-content;
226+
border-radius: 10px;
227+
}
228+
kbd {
229+
border-radius: 5px;
230+
padding: 0px 5px 5px 5px;
231+
box-shadow: inset 0 -3.75px 0 0 var(--vp-c-gray-3);
232+
font-family: var(--vp-font-family-mono) !important;
233+
}
234+
h3 {
235+
margin-top: 0 !important;
236+
}
237+
.vp-doc p {
238+
margin: 8px 0 !important;
219239
}

docs/getting-started/afterwards.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
prev:
3+
text: New pack
4+
link: new/new-pack
5+
mentions:
6+
- NSPC911
7+
---
8+
# Now what?
9+
10+
Now that you have created a new category/pack, what do you do now?
11+
12+
## Run pre_commit.py
13+
- What is that?
14+
15+
It is a multi-purpose script designed to help the process of creating!<br>Run it with `python pys/pre_commit.py` from the root directory
16+
17+
Main things that it does:
18+
- Creates a backup for you to restore on if you lose anything (saved to git stash)
19+
- Adds your pack/category to the maps required to download a pack
20+
- Updates the website for testing
21+
- Updates the stats in README.md
22+
- Formats files (if run with flag `--format`)
23+
- Builds packs (if run with flag `--build pack` on behaviour-packs)
24+
25+
## Open a Pull Request
26+
- What is that?
27+
28+
It allows you to suggest changes in the repository! If you go to your repo's main directory, GitHub will suggest you to open a Pull Request.
29+
30+
Open it and maybe you might get your first contribution!
31+
32+
<Contributors />

docs/getting-started/new-pack.md

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

docs/getting-started/setting-up.md

Lines changed: 2 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ prev:
44
link: index
55
next:
66
text: Creating a new Pack
7-
link: getting-started/new-pack
7+
link: new/new-pack
88
mentions:
99
- NSPC911
1010
---
@@ -15,6 +15,7 @@ You will need
1515
- You can also get a GUI Client like [Git GUI](https://git-scm.com/docs/git-gui) and [GitHub Desktop](https://desktop.github.com/) or complicated ones like [Sourcegit](https://github.com/sourcegit-scm/sourcegit/releases/latest) or [Lazygit](https://github.com/jesseduffield/lazygit)
1616
- [Python 3+](https://www.python.org/downloads/)
1717
- [NodeJS](https://nodejs.org/en)
18+
- Code Editor (recommended)
1819

1920
## Setting up pack repositories
2021

@@ -30,35 +31,6 @@ You will need
3031
cd resource-packs
3132
```
3233

33-
2. Create missing folders
34-
35-
```sh
36-
python pys\folder_creator.py
37-
```
38-
- Type in `0` to not print anything.
39-
40-
## Setting up the server
41-
42-
1. Clone the repository
43-
44-
```sh
45-
git clone https://github.com/BEComTweaks/server-backend --recursive
46-
```
47-
> Recursive cloning is neccessary as there are submodules in the repository
48-
49-
- cd into the repository's folder
50-
51-
```sh
52-
cd server-backend
53-
```
54-
55-
2. Get neccessary node modules
56-
57-
```sh
58-
npm install
59-
```
60-
61-
---
6234
That's it!
6335
6436
<Contributors />

docs/jsons/other-jsons.md

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

docs/jsons/pack-jsons.md

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

0 commit comments

Comments
 (0)