Skip to content

Commit 10ccae7

Browse files
AmeliaCuteAmeliaCute
committed
First cummit
0 parents  commit 10ccae7

17 files changed

Lines changed: 914 additions & 0 deletions

File tree

‎.github/workflows/deploy.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Deploy vite to Github pages
2+
on:
3+
push:
4+
branches: [main]
5+
workflow_dispatch:
6+
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
12+
concurrency:
13+
group: pages
14+
cancel-in-progress: false
15+
16+
jobs:
17+
build:
18+
runs-on:
19+
steps:
20+
- name: Checkout
21+
uses: actions/checkout@v4
22+
with:
23+
fetch-depth: 0
24+
25+
- name: Setup Node
26+
uses: actions/setup-node@v4
27+
with:
28+
node-version: 22
29+
cache: npm
30+
31+
- name: Setup Pages
32+
uses: actions/configure-pages@v4
33+
34+
- name: Install dep
35+
run: bun Install
36+
37+
- name: Build
38+
run: bun run docs:build
39+
40+
- name: Upload artifact
41+
uses: actions/upload-pages-artifact@v3
42+
with:
43+
patch: docs/.vitepress/dist
44+
45+
deploy:
46+
environement:
47+
name: github-pages
48+
url: ${{ steps.deployement.outputs.page_url }}
49+
needs: build
50+
runs-on: ubuntu-latest
51+
name: Deploy
52+
steps:
53+
- name: Deploy to GitHub pages
54+
id: deployment
55+
uses: actions/deploy-pages@v4

‎bun.lock‎

Lines changed: 321 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/.images/nfl1-win-arch.png‎

31.6 KB
Loading

‎docs/.images/nfl1-win-inst.png‎

33.5 KB
Loading

‎docs/.images/stm-blf.png‎

50.9 KB
Loading

‎docs/.vitepress/config.mts‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
title: "FliAPI doc",
6+
description: "Documentation for FLiAPI",
7+
base: '/fliapi-doc/',
8+
themeConfig:
9+
{
10+
// https://vitepress.dev/reference/default-theme-config
11+
nav: [
12+
{ text: 'Home', link: '/' },
13+
{ text: 'Install', link: '/quick-setup/installation' },
14+
{ text: 'Documentation', link: '/api-documentation/creating-mod'}
15+
],
16+
17+
footer:
18+
{
19+
message: "Love u all ❤️",
20+
copyright: "Released under the MIT License"
21+
},
22+
23+
sidebar:
24+
[
25+
{
26+
text: 'Quick setup',
27+
items:
28+
[
29+
{ text: 'Installation', link: '/quick-setup/installation' },
30+
{ text: 'Adding mods', link: '/quick-setup/add-mods'}
31+
]
32+
},
33+
{
34+
text: 'API documentation',
35+
items: [
36+
{text: 'Creating a mod', link: '/api-documentation/creating-mod'},
37+
{
38+
text: 'Mod',
39+
items:
40+
[
41+
{ text: 'Mod Base', link: '/api-documentation/mod/mod-base' },
42+
{ text: 'Mod Configuration', link: '/api-documentation/mod/configuration' }
43+
]
44+
}
45+
]
46+
}
47+
],
48+
49+
search:
50+
{
51+
provider: 'local'
52+
},
53+
54+
socialLinks: [
55+
{ icon: 'github', link: 'https://github.com/ReDevCafe' },
56+
{ icon: 'nexusmods', link: 'https://www.nexusmods.com/fantasylifeithegirlwhostealstime/mods/44', },
57+
{ icon: 'gamebanana', link: 'https://gamebanana.com/tools/20956'}
58+
]
59+
}
60+
})

‎docs/.vitepress/theme/index.ts‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// https://vitepress.dev/guide/custom-theme
2+
import { h } from 'vue'
3+
import type { Theme } from 'vitepress'
4+
import DefaultTheme from 'vitepress/theme'
5+
import './style.css'
6+
7+
export default {
8+
extends: DefaultTheme,
9+
Layout: () => {
10+
return h(DefaultTheme.Layout, null, {
11+
// https://vitepress.dev/guide/extending-default-theme#layout-slots
12+
})
13+
},
14+
enhanceApp({ app, router, siteData }) {
15+
// ...
16+
}
17+
} satisfies Theme

‎docs/.vitepress/theme/style.css‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
/**
2+
* Customize default theme styling by overriding CSS variables:
3+
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
4+
*/
5+
6+
/**
7+
* Colors
8+
*
9+
* Each colors have exact same color scale system with 3 levels of solid
10+
* colors with different brightness, and 1 soft color.
11+
*
12+
* - `XXX-1`: The most solid color used mainly for colored text. It must
13+
* satisfy the contrast ratio against when used on top of `XXX-soft`.
14+
*
15+
* - `XXX-2`: The color used mainly for hover state of the button.
16+
*
17+
* - `XXX-3`: The color for solid background, such as bg color of the button.
18+
* It must satisfy the contrast ratio with pure white (#ffffff) text on
19+
* top of it.
20+
*
21+
* - `XXX-soft`: The color used for subtle background such as custom container
22+
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
23+
* on top of it.
24+
*
25+
* The soft color must be semi transparent alpha channel. This is crucial
26+
* because it allows adding multiple "soft" colors on top of each other
27+
* to create an accent, such as when having inline code block inside
28+
* custom containers.
29+
*
30+
* - `default`: The color used purely for subtle indication without any
31+
* special meanings attached to it such as bg color for menu hover state.
32+
*
33+
* - `brand`: Used for primary brand colors, such as link text, button with
34+
* brand theme, etc.
35+
*
36+
* - `tip`: Used to indicate useful information. The default theme uses the
37+
* brand color for this by default.
38+
*
39+
* - `warning`: Used to indicate warning to the users. Used in custom
40+
* container, badges, etc.
41+
*
42+
* - `danger`: Used to show error, or dangerous message to the users. Used
43+
* in custom container, badges, etc.
44+
* -------------------------------------------------------------------------- */
45+
46+
:root {
47+
--vp-c-default-1: var(--vp-c-gray-1);
48+
--vp-c-default-2: var(--vp-c-gray-2);
49+
--vp-c-default-3: var(--vp-c-gray-3);
50+
--vp-c-default-soft: var(--vp-c-gray-soft);
51+
52+
--vp-c-brand-1: var(--vp-c-indigo-1);
53+
--vp-c-brand-2: var(--vp-c-indigo-2);
54+
--vp-c-brand-3: var(--vp-c-indigo-3);
55+
--vp-c-brand-soft: var(--vp-c-indigo-soft);
56+
57+
--vp-c-tip-1: var(--vp-c-brand-1);
58+
--vp-c-tip-2: var(--vp-c-brand-2);
59+
--vp-c-tip-3: var(--vp-c-brand-3);
60+
--vp-c-tip-soft: var(--vp-c-brand-soft);
61+
62+
--vp-c-warning-1: var(--vp-c-yellow-1);
63+
--vp-c-warning-2: var(--vp-c-yellow-2);
64+
--vp-c-warning-3: var(--vp-c-yellow-3);
65+
--vp-c-warning-soft: var(--vp-c-yellow-soft);
66+
67+
--vp-c-danger-1: var(--vp-c-red-1);
68+
--vp-c-danger-2: var(--vp-c-red-2);
69+
--vp-c-danger-3: var(--vp-c-red-3);
70+
--vp-c-danger-soft: var(--vp-c-red-soft);
71+
}
72+
73+
/**
74+
* Component: Button
75+
* -------------------------------------------------------------------------- */
76+
77+
:root {
78+
--vp-button-brand-border: transparent;
79+
--vp-button-brand-text: var(--vp-c-white);
80+
--vp-button-brand-bg: var(--vp-c-brand-3);
81+
--vp-button-brand-hover-border: transparent;
82+
--vp-button-brand-hover-text: var(--vp-c-white);
83+
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
84+
--vp-button-brand-active-border: transparent;
85+
--vp-button-brand-active-text: var(--vp-c-white);
86+
--vp-button-brand-active-bg: var(--vp-c-brand-1);
87+
}
88+
89+
/**
90+
* Component: Home
91+
* -------------------------------------------------------------------------- */
92+
93+
:root {
94+
--vp-home-hero-name-color: transparent;
95+
--vp-home-hero-name-background: -webkit-linear-gradient(
96+
120deg,
97+
#fe34fe 30%,
98+
#41ffc0
99+
);
100+
101+
--vp-home-hero-image-background-image: linear-gradient(
102+
-45deg,
103+
#bd34fe 50%,
104+
#47caff 50%
105+
);
106+
--vp-home-hero-image-filter: blur(44px);
107+
}
108+
109+
@media (min-width: 640px) {
110+
:root {
111+
--vp-home-hero-image-filter: blur(56px);
112+
}
113+
}
114+
115+
@media (min-width: 960px) {
116+
:root {
117+
--vp-home-hero-image-filter: blur(68px);
118+
}
119+
}
120+
121+
/**
122+
* Component: Custom Block
123+
* -------------------------------------------------------------------------- */
124+
125+
:root {
126+
--vp-custom-block-tip-border: transparent;
127+
--vp-custom-block-tip-text: var(--vp-c-text-1);
128+
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
129+
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
130+
}
131+
132+
/**
133+
* Component: Algolia
134+
* -------------------------------------------------------------------------- */
135+
136+
.DocSearch {
137+
--docsearch-primary-color: var(--vp-c-brand-1) !important;
138+
}
139+

‎docs/api-documentation/creating-mod.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Creating mods
2+
3+
Creating mods has been made easier with a [template](https://github.com/ReDevCafe/FantasyLifeI-ModTemplate) on our github.
4+
5+
You can also clone it with:
6+
```bash
7+
$ git clone --recurse-submodules https://github.com/ReDevCafe/FantasyLifeI-ModTemplate YOUR_MOD_NAME
8+
$ cd YOUR_MOD_NAME
9+
```
10+
11+
### Configure your mod
12+
In your repository you will find two important files:
13+
- `resource/Mod.json`
14+
- `CMakeLists.txt`
15+
16+
##### 1. Configure your CMake project
17+
18+
There are two things you need to modify in `CMakeLists.txt`.
19+
20+
The project name (replace `"FliMod"` with your mod's name)
21+
```cmake
22+
project(FLiMod LANGUAGES CXX C)
23+
```
24+
25+
And the ModLoader library version, you can find all versions [here](https://github.com/ReDevCafe/FantasyLifeI-API/releases):
26+
```cmake
27+
set(MODLOADER_BUILD_VERSION "v20250915.2026")
28+
```
29+
30+
::: tip
31+
If you want to use a custom build, you can comment out these lines:
32+
33+
```cmake
34+
#file(DOWNLOAD ${MODLOADER_URL} ${MODLOADER_LIB_PATH} SHOW_PROGRESS STATUS DOWNLOAD_STATUS)
35+
36+
#list(GET DOWNLOAD_STATUS 0 DOWNLOAD_RESULT)
37+
#if(NOT DOWNLOAD_RESULT EQUAL 0)
38+
# message(FATAL_ERROR "Failed to download ModLoader.lib (status ${DOWNLOAD_RESULT})")
39+
#endif()
40+
```
41+
42+
Then place your own `ModLoader.lib` inside the `lib` folder.
43+
:::
44+
45+
##### 2. Configure you Mod metadata
46+
47+
::: tip
48+
The metadata file is located at `resource/Mod.json`
49+
:::
50+
51+
a sample `Mod.json`:
52+
```json
53+
{
54+
"title": "My Mod",
55+
"identifier": "mymod",
56+
"author": "Me",
57+
"version": 1.0,
58+
"dependencies": {
59+
"fliapi": 1.0
60+
}
61+
}
62+
```
63+
64+
Explanation of each field:
65+
- `title`: The name of your mod, can contain spaces, number, ect.. Useful for displaying in a mod menu.
66+
- `identifier`: A unique ID for your mod, used by other mods to define dependencies.
67+
- `author`: Your display name.
68+
- `version`: The version of your, useful for dependecy management.
69+
- `dependencies`: A list of dependencies, each entry has a `key` **(the mod ID of the required mod)** and a `value` **(the minimum version required)**
70+
71+
### Build and Package Your Mod
72+
Once your files are configured, you can build the mod.
73+
74+
###### 1. Use CMake to configure and generate project files
75+
```bash
76+
$ mkdir build
77+
$ cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
78+
```
79+
80+
###### 2. Build your project
81+
```bash
82+
$ cmake --build build --config Release --target package_mod
83+
```
84+
85+
::: tip
86+
After building, your mod archive can be found at `build/packages/*.fliarchive`
87+
:::
88+
89+
### References:
90+
- [Mod Template](https://github.com/ReDevCafe/FantasyLifeI-ModTemplate)
91+
- [CMakeLists](https://github.com/ReDevCafe/FantasyLifeI-ModTemplate/blob/master/CMakeLists.txt)
92+
- [Mod Meta](https://github.com/ReDevCafe/FantasyLifeI-ModTemplate/blob/master/resource/Mod.json)

‎docs/api-documentation/index.md‎

Whitespace-only changes.

0 commit comments

Comments
 (0)