Skip to content

Commit 5744572

Browse files
NSPC911NSPC911
committed
improv a lot
1 parent eb89f04 commit 5744572

File tree

11 files changed

+147
-137
lines changed

11 files changed

+147
-137
lines changed

‎docs/.vitepress/config.mts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ export default defineConfig({
3737
{ text: 'New Compatibility', link: 'new/new-compatibility' },
3838
]
3939
},
40+
{
41+
text: 'Now what?',
42+
items: [
43+
{ text: 'Now what?', link: 'getting-started/afterwards'}
44+
]
45+
},
4046
{
4147
text: 'Scripts',
4248
items: [

‎docs/.vitepress/theme/components/Pages.vue

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<template>
2+
<div class="pager">
3+
<a :class="['VPLink', 'link', 'pager-link', direction]" :href="link">
4+
<span class="desc">{{ desc }}</span>
5+
<span class="title">{{ title }}</span>
6+
</a>
7+
</div>
8+
</template>
9+
10+
<script setup>
11+
const props = defineProps({
12+
direction: {
13+
type: String,
14+
required: true,
15+
validator: value => ['next', 'prev'].includes(value)
16+
},
17+
link: {
18+
type: String,
19+
required: true
20+
},
21+
desc: {
22+
type: String,
23+
required: true
24+
},
25+
title: {
26+
type: String,
27+
required: true
28+
}
29+
});
30+
</script>
31+
32+
<style scoped>
33+
.pager {
34+
display: block;
35+
border: 1px solid var(--vp-c-divider);
36+
border-radius: 8px;
37+
padding: 11px 16px 13px;
38+
width: 100%;
39+
&:hover {
40+
border-color: var(--vp-c-brand-1);
41+
}
42+
}
43+
44+
.pager-link {
45+
display: flex;
46+
flex-direction: column;
47+
text-decoration: none;
48+
color: var(--vp-c-text);
49+
}
50+
51+
.pager-link.next {
52+
align-items: flex-end;
53+
}
54+
55+
.pager-link.prev {
56+
align-items: flex-start;
57+
}
58+
59+
.desc {
60+
font-size: 12px;
61+
color: var(--vp-c-text-2);
62+
}
63+
64+
.title {
65+
font-size: 1.25rem;
66+
font-weight: bold;
67+
color: var(--vp-c-brand-1);
68+
}
69+
</style>

‎docs/.vitepress/theme/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import DefaultTheme from 'vitepress/theme'
55
import './style.css'
66
import Contributors from './components/Contributors.vue';
77
import 'virtual:group-icons.css';
8+
import PageButton from './components/Pages.vue';
89

910
export default {
1011
extends: DefaultTheme,
@@ -15,5 +16,6 @@ export default {
1516
},
1617
enhanceApp({ app, router, siteData }) {
1718
app.component('Contributors', Contributors);
19+
app.component('PageButton', PageButton);
1820
}
1921
} satisfies Theme

‎docs/getting-started/afterwards.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
2-
prev:
3-
text: New pack
4-
link: new/new-pack
2+
prev: false
3+
next: false
54
mentions:
65
- NSPC911
76
---
@@ -29,4 +28,11 @@ Now that you have created a new category/pack, what do you do now?
2928

3029
Open it and maybe you might get your first contribution!
3130

32-
<Contributors />
31+
<Contributors />
32+
---
33+
<h3 style="margin-top: -10px !important; margin-bottom: 10px;">Other Pages</h3>
34+
<div style="display: grid; gap: 10px; grid-template-columns: auto-fit">
35+
<PageButton direction="prev" link="../new/new-compatibility" desc="Previous page" title="Creating a new Compatibility" />
36+
<PageButton direction="prev" link="../new/new-pack" desc="Previous page" title="Creating a new Pack" />
37+
<PageButton direction="prev" link="../new/new-category" desc="Previous page" title="Creating a new Category" />
38+
</div>

‎docs/getting-started/setting-up.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
---
2-
prev:
3-
text: Home
4-
link: index
2+
prev: false
53
next: false
64
mentions:
75
- NSPC911
@@ -31,4 +29,10 @@ You will need
3129

3230
That's it!
3331
34-
<Contributor/>
32+
<Contributor/>
33+
---
34+
<div style="display: grid; gap: 10px; grid-template-columns: auto-fit">
35+
<PageButton direction="next" link="../new/new-compatibility" desc="Next page" title="Creating a new Compatibility" />
36+
<PageButton direction="next" link="../new/new-pack" desc="Next page" title="Creating a new Pack" />
37+
<PageButton direction="next" link="../new/new-category" desc="Next page" title="Creating a new Category" />
38+
</div>

‎docs/new/new-category.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
---
2-
prev:
3-
text: Setting up
4-
link: getting-started/setting-up
5-
next:
6-
text: Creating a new Pack
7-
link: new/new-pack
2+
prev: false
3+
next: false
84
mentions:
95
- NSPC911
106
---
@@ -118,4 +114,14 @@ const listofcategories
118114
### Create a pack
119115
Now that your category is set, maybe create a new pack? If so, refer to [`Create a new pack`](new-pack)
120116

121-
<Contributors />
117+
<Contributors />
118+
---
119+
<div style="display: flex; justify-content: space-between; gap: 10px" >
120+
<div style="display: flex; flex-direction: column; gap: 10px; flex: 1;">
121+
<PageButton direction="prev" link="../new/new-pack" desc="Previous page" title="Creating a new Pack" />
122+
<PageButton direction="prev" link="../new/new-compatibility" desc="Previous page" title="Creating a new Compatibility" />
123+
</div>
124+
<div style="display: flex; flex-direction: column; gap: 10px; flex: 1; align-items: flex-end;">
125+
<PageButton direction="next" link="../getting-started/afterwards" desc="Next page" title="Now what?" />
126+
</div>
127+
</div>

‎docs/new/new-compatibility.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
---
2-
prev:
3-
text: Setting up
4-
link: getting-started/setting-up
5-
next:
6-
text: Creating a new Pack
7-
link: new/new-pack
2+
prev: false
3+
next: false
84
mentions:
95
- NSPC911
106
---
@@ -60,13 +56,31 @@ Say you want to add a 4 way compatibility while using the example `compatibility
6056
2. Create a new key called `4way`
6157

6258
Here is how the key would look like
63-
```json [jsons/packs/compatibility.json]
64-
"2way": {
59+
```json [jsons/packs/compatibility.json]
60+
"4way": {
6561
"compatibilities": [
6662
["packid1", "packid2", "packid3", "packid4"]
6763
],
6864
"locations": [
6965
"compatibility/packid1234"
7066
]
7167
}
72-
```
68+
```
69+
- The `compatibility` key contains the list of packs with compatibilities within each other
70+
- The `locations` key contains their respective location with respective from `./packs`
71+
- In this case, the location is `compatibility/packid1234`, so it will be located at `packs/compatibility/packid1234`
72+
73+
If you are making an n-way compatibility where `n` is lesser than `maxway`, then you can just add onto the existing `n-way` key
74+
75+
That should be about it!
76+
<Contributors/>
77+
---
78+
<div style="display: flex; justify-content: space-between; gap: 10px" >
79+
<div style="display: flex; flex-direction: column; gap: 10px; flex: 1;">
80+
<PageButton direction="prev" link="../new/new-pack" desc="Previous page" title="Creating a new Pack" />
81+
<PageButton direction="prev" link="../new/new-category" desc="Previous page" title="Creating a new Category" />
82+
</div>
83+
<div style="display: flex; flex-direction: column; gap: 10px; flex: 1; align-items: flex-end;">
84+
<PageButton direction="next" link="../getting-started/afterwards" desc="Next page" title="Now what?" />
85+
</div>
86+
</div>

‎docs/new/new-pack.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
---
2-
prev:
3-
text: Setting up
4-
link: getting-started/setting-up
5-
next:
6-
text: What next?
7-
link: getting-started/afterwards
2+
prev: false
3+
next: false
84
mentions:
95
- NSPC911
106
---
@@ -143,5 +139,14 @@ You can start adding the files!
143139
If you are using a build script, you will need to create another directory to house the 'raw' files, add the script and its corresponding key in the pack's JSON (refer above)
144140

145141
An example script is available in <kbd>./pys/example_builder.py</kbd>
146-
147-
<Contributors />
142+
<Contributors/>
143+
---
144+
<div style="display: flex; justify-content: space-between; gap: 10px" >
145+
<div style="display: flex; flex-direction: column; gap: 10px; flex: 1;">
146+
<PageButton direction="prev" link="../new/new-compatibility" desc="Previous page" title="Creating a new Compatibility" />
147+
<PageButton direction="prev" link="../new/new-category" desc="Previous page" title="Creating a new Category" />
148+
</div>
149+
<div style="display: flex; flex-direction: column; gap: 10px; flex: 1; align-items: flex-end;">
150+
<PageButton direction="next" link="../getting-started/afterwards" desc="Next page" title="Now what?" />
151+
</div>
152+
</div>

‎docs/scripts/js-files.md

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

‎docs/scripts/py-files.md

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

‎docs/to-do.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Stuff to do or in progress.<br>Feel free to help me with these!
1010
- Make a proper footer aside from the credits footer
1111
- Make an easily accessible console log like in [BEComTweaks/btrp-updater](https://github.com/BEComTweaks/btrp-updater)
1212
- Move away from a server to full frontend
13-
- Resource Packs
14-
- Behaviour Packs [`no-backend`](https://github.com/BEComTweaks/behaviour-packs/tree/no-backend)
15-
- Crafting Tweaks
13+
- Resource Packs
14+
- Behaviour Packs [`no-backend`](https://github.com/BEComTweaks/behaviour-packs/tree/no-backend)
15+
- Crafting Tweaks
1616
- docs
1717
- Finish it up! <!--too lazy-->
1818

0 commit comments

Comments
 (0)