Skip to content

Commit

Permalink
pre-update v1 for 3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
NSPC911 committed Jan 9, 2025
1 parent a79f684 commit 99e0961
Show file tree
Hide file tree
Showing 9 changed files with 326 additions and 226 deletions.
14 changes: 4 additions & 10 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ export default defineConfig({
sidebar: [
{ text: 'Getting Started',
items: [
{ text: 'Setting Up', link: 'getting-started/setting-up' }
// { text: 'New Pack', link: 'getting-started/new-pack' }
// { text: 'New Category', link: 'getting-started/new-category' }
{ text: 'Setting Up', link: 'getting-started/setting-up' },
{ text: 'Creating a New Pack', link: 'new/new-pack' },
{ text: 'Creating a New Category', link: 'new/new-category' },
{ text: 'Now what?', link: 'getting-started/afterwards' }
]
},
{
Expand All @@ -36,13 +37,6 @@ export default defineConfig({
// { text: 'JS Files', link: 'scripts/js-files' }
]
},
{
text: 'JSONs',
items: [
{ text: 'Other JSONs', link: 'jsons/other-jsons' },
{ text: 'Pack JSONs', link: 'jsons/pack-jsons' }
]
},
{
text: 'Misc',
items: [
Expand Down
20 changes: 20 additions & 0 deletions docs/.vitepress/theme/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -216,4 +216,24 @@
}
.VPSidebar {
padding-bottom: 16px !important;
}

.unnecessary-codeblock,
kbd {
background-color: var(--vp-code-block-bg);
padding: 5px 10px;
width: fit-content;
border-radius: 10px;
}
kbd {
border-radius: 5px;
padding: 0px 5px 5px 5px;
box-shadow: inset 0 -3.75px 0 0 var(--vp-c-gray-3);
font-family: var(--vp-font-family-mono) !important;
}
h3 {
margin-top: 0 !important;
}
.vp-doc p {
margin: 8px 0 !important;
}
32 changes: 32 additions & 0 deletions docs/getting-started/afterwards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
prev:
text: New pack
link: new/new-pack
mentions:
- NSPC911
---
# Now what?

Now that you have created a new category/pack, what do you do now?

## Run pre_commit.py
- What is that?

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

Main things that it does:
- Creates a backup for you to restore on if you lose anything (saved to git stash)
- Adds your pack/category to the maps required to download a pack
- Updates the website for testing
- Updates the stats in README.md
- Formats files (if run with flag `--format`)
- Builds packs (if run with flag `--build pack` on behaviour-packs)

## Open a Pull Request
- What is that?

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.

Open it and maybe you might get your first contribution!

<Contributors />
10 changes: 0 additions & 10 deletions docs/getting-started/new-pack.md

This file was deleted.

32 changes: 2 additions & 30 deletions docs/getting-started/setting-up.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ prev:
link: index
next:
text: Creating a new Pack
link: getting-started/new-pack
link: new/new-pack
mentions:
- NSPC911
---
Expand All @@ -15,6 +15,7 @@ You will need
- 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)
- [Python 3+](https://www.python.org/downloads/)
- [NodeJS](https://nodejs.org/en)
- Code Editor (recommended)

## Setting up pack repositories

Expand All @@ -30,35 +31,6 @@ You will need
cd resource-packs
```

2. Create missing folders

```sh
python pys\folder_creator.py
```
- Type in `0` to not print anything.

## Setting up the server

1. Clone the repository

```sh
git clone https://github.com/BEComTweaks/server-backend --recursive
```
> Recursive cloning is neccessary as there are submodules in the repository

- cd into the repository's folder
```sh
cd server-backend
```
2. Get neccessary node modules
```sh
npm install
```
---
That's it!
<Contributors />
47 changes: 0 additions & 47 deletions docs/jsons/other-jsons.md

This file was deleted.

129 changes: 0 additions & 129 deletions docs/jsons/pack-jsons.md

This file was deleted.

Loading

0 comments on commit 99e0961

Please sign in to comment.