Skip to content

Commit 5c70f82

Browse files
Little100Little100
committed
文档(ai写的)
1 parent ca35457 commit 5c70f82

13 files changed

Lines changed: 1460 additions & 7 deletions

File tree

‎.github/workflows/docs.yml‎

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

‎.gitignore‎

Lines changed: 43 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,49 @@
1+
# IDE
12
.idea/
3+
.vscode/
4+
*.iml
5+
*.ipr
6+
*.iws
7+
8+
# Gradle
29
.gradle/
310
build/
411
gradle/
12+
bin/
13+
out/
14+
15+
# Minecraft/Plugin
16+
run/
517
ProjectE Resourcepack/
618
ProjectE Resourcepack 1.21.4+/
7-
run/
8-
.vscode/
9-
bin/
10-
custommodeldata1.21.4.md
11-
ProjectE Datapack
12-
InventoryStacks
19+
ProjectE Datapack/
20+
InventoryStacks/
21+
22+
# VuePress
23+
node_modules/
24+
docs/.vuepress/.cache/
25+
docs/.vuepress/.temp/
26+
docs/.vuepress/dist/
27+
28+
# npm/yarn
29+
package-lock.json
30+
yarn.lock
31+
pnpm-lock.yaml
32+
npm-debug.log*
33+
yarn-debug.log*
34+
yarn-error.log*
35+
36+
# OS
37+
.DS_Store
38+
Thumbs.db
39+
*.swp
40+
*.swo
41+
*~
42+
43+
# Logs
44+
*.log
45+
46+
# Temporary files
47+
*.tmp
48+
*.bak
49+
custommodeldata1.21.4.md

‎docs/.vuepress/config.js‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
import { viteBundler } from '@vuepress/bundler-vite'
2+
import { defaultTheme } from '@vuepress/theme-default'
3+
import { defineUserConfig } from 'vuepress'
4+
import { searchPlugin } from '@vuepress/plugin-search'
5+
6+
export default defineUserConfig({
7+
bundler: viteBundler(),
8+
9+
// 多语言配置
10+
locales: {
11+
'/': {
12+
lang: 'zh-CN',
13+
title: 'ProjectE 插件',
14+
description: 'Minecraft Spigot 等价交换插件文档'
15+
},
16+
'/en/': {
17+
lang: 'en-US',
18+
title: 'ProjectE Plugin',
19+
description: 'Minecraft Spigot Equivalent Exchange Plugin Documentation'
20+
}
21+
},
22+
23+
base: '/ProjectE-plugin/',
24+
25+
theme: defaultTheme({
26+
logo: '/images/Philosopher_Stone.png',
27+
28+
locales: {
29+
'/': {
30+
selectLanguageName: '简体中文',
31+
navbar: [
32+
{ text: '首页', link: '/' },
33+
{ text: '指南', link: '/guide/' },
34+
{ text: 'GitHub', link: 'https://github.com/Little100/ProjectE-plugin' }
35+
],
36+
sidebar: {
37+
'/guide/': [
38+
{
39+
text: '指南',
40+
children: [
41+
'/guide/README.md',
42+
'/guide/installation.md',
43+
'/guide/commands.md',
44+
'/guide/permissions.md'
45+
]
46+
}
47+
]
48+
},
49+
editLinkText: '在 GitHub 上编辑此页',
50+
lastUpdatedText: '上次更新',
51+
contributorsText: '贡献者'
52+
},
53+
'/en/': {
54+
selectLanguageName: 'English',
55+
navbar: [
56+
{ text: 'Home', link: '/en/' },
57+
{ text: 'Guide', link: '/en/guide/' },
58+
{ text: 'GitHub', link: 'https://github.com/Little100/ProjectE-plugin' }
59+
],
60+
sidebar: {
61+
'/en/guide/': [
62+
{
63+
text: 'Guide',
64+
children: [
65+
'/en/guide/README.md',
66+
'/en/guide/installation.md',
67+
'/en/guide/commands.md',
68+
'/en/guide/permissions.md'
69+
]
70+
}
71+
]
72+
},
73+
editLinkText: 'Edit this page on GitHub',
74+
lastUpdatedText: 'Last Updated',
75+
contributorsText: 'Contributors'
76+
}
77+
},
78+
79+
repo: 'Little100/ProjectE-plugin',
80+
docsDir: 'docs',
81+
editLink: true,
82+
lastUpdated: true,
83+
contributors: true
84+
}),
85+
86+
plugins: [
87+
searchPlugin({
88+
locales: {
89+
'/': {
90+
placeholder: '搜索',
91+
},
92+
'/en/': {
93+
placeholder: 'Search',
94+
}
95+
}
96+
})
97+
]
98+
})

‎docs/.vuepress/public/images/Philosopher_Stone.png‎

5.16 KB
Loading

‎docs/README.md‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
home: true
3+
heroImage: /images/Philosopher_Stone.png
4+
heroText: ProjectE Plugin
5+
tagline: Minecraft Spigot 等价交换插件
6+
actions:
7+
- text: 快速开始 →
8+
link: /guide/
9+
type: primary
10+
- text: 查看 GitHub
11+
link: https://github.com/yourusername/ProjectE-plugin
12+
type: secondary
13+
features:
14+
- title: 🔮 等价交换系统
15+
details: 完整实现了等价交换模组的核心功能，包括 EMC 系统、物品转换和能量管理
16+
- title: 🛠️ 丰富的工具和设备
17+
details: 提供贤者之石、炼金术袋、能量收集器、暗物质熔炉等多种工具和设备
18+
- title: 💎 强大的装备系统
19+
details: 包含宝石头盔、各种护身符等强大的装备，提升游戏体验
20+
- title: 🎨 完整的材质包支持
21+
details: 提供官方材质包和数据包，让插件拥有与模组相同的视觉体验
22+
- title: ⚙️ 高度可配置
23+
details: 支持自定义 EMC 值、配方、设备参数等，满足不同服务器的需求
24+
- title: 🌍 多语言支持
25+
details: 支持简体中文、英文等多种语言，方便不同地区的玩家使用
26+
footer: MIT Licensed | Copyright © 2024-present Little_100
27+
---
28+
29+
## 🚀 快速安装
30+
31+
```bash
32+
# 1. 下载插件
33+
# 从 GitHub Releases 下载最新版本的 ProjectE.jar
34+
35+
# 2. 安装插件
36+
# 将 ProjectE.jar 放入服务器的 plugins 文件夹
37+
38+
# 3. 重启服务器
39+
# 重启服务器以加载插件
40+
41+
# 4. 安装资源包（可选但推荐）
42+
# 将提供的资源包和数据包安装到服务器
43+
```
44+
45+
## 📦 核心功能
46+
47+
### EMC 系统
48+
ProjectE 的核心是 EMC（Energy-Matter Covalence）系统。玩家可以将物品分解为 EMC，并使用 EMC 创造新的物品。
49+
50+
### 转换桌
51+
使用转换桌可以将已学习的物品相互转换，只需消耗相应的 EMC。
52+
53+
### 能量收集器
54+
自动从阳光中收集能量，为克莱因之星充能。
55+
56+
### 炼金术设备
57+
包括能量凝聚器、炼金术箱子、暗物质熔炉等多种实用设备。
58+
59+
## 🎮 主要物品
60+
61+
- **贤者之石**: 核心工具，用于物品转换和合成
62+
- **克莱因之星**: 存储 EMC 的容器
63+
- **炼金术袋**: 便携式存储容器
64+
- **暗物质工具**: 强大的工具套装
65+
- **红物质工具**: 更强大的工具套装
66+
- **宝石护甲**: 提供特殊能力的护甲
67+
68+
## 📊 版本信息
69+
70+
- **当前版本**: 1.2.4
71+
- **支持的 Minecraft 版本**: 1.16.5 - 1.21+
72+
- **依赖**: Spigot/Paper 服务端
73+
74+
## 🤝 社区支持
75+
76+
如果你在使用过程中遇到问题，可以：
77+
78+
- 查看[完整文档](/guide/)
79+
- 提交 [Issue](https://github.com/yourusername/ProjectE-plugin/issues)
80+
- 加入我们的社区讨论
81+
82+
## 📝 更新日志
83+
84+
查看[更新日志](https://github.com/yourusername/ProjectE-plugin/blob/main/changelog.md)了解最新的更新内容。
85+
86+
## ⚖️ 许可证
87+
88+
本项目采用 MIT 许可证。详见 [LICENSE](https://github.com/yourusername/ProjectE-plugin/blob/main/LICENSE) 文件。

‎docs/en/README.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
2+
---
3+
home: true
4+
heroImage: /images/Philosopher_Stone.png
5+
heroText: ProjectE Plugin
6+
tagline: Minecraft Spigot Equivalent Exchange Plugin
7+
actions:
8+
- text: Get Started →
9+
link: /en/guide/
10+
type: primary
11+
- text: View on GitHub
12+
link: https://github.com/Little100/ProjectE-plugin
13+
type: secondary
14+
features:
15+
- title: 🔮 Equivalent Exchange System
16+
details: Complete implementation of the Equivalent Exchange mod's core features, including EMC system, item conversion, and energy management
17+
- title: 🛠️ Rich Tools and Devices
18+
details: Provides various tools and devices such as Philosopher's Stone, Alchemical Bags, Energy Collectors, Dark Matter Furnaces, and more
19+
- title: 💎 Powerful Equipment System
20+
details: Includes Gem Helmet, various talismans, and other powerful equipment to enhance gameplay experience
21+
- title: 🎨 Full Resource Pack Support
22+
details: Provides official resource pack and datapack for the same visual experience as the mod
23+
- title: ⚙️ Highly Configurable
24+
details: Supports custom EMC values, recipes, device parameters, etc., to meet different server needs
25+
- title: 🌍 Multi-language Support
26+
details: Supports Simplified Chinese, English, and other languages for players from different regions
27+
footer: MIT Licensed | Copyright © 2024-present Little_100
28+
---
29+
30+
## 🚀 Quick Installation
31+
32+
```bash
33+
# 1. Download the plugin
34+
# Download the latest version of ProjectE.jar from GitHub Releases
35+
36+
# 2. Install the plugin
37+
# Place ProjectE.jar in the server's plugins folder
38+
39+
# 3. Restart the server
40+
# Restart the server to load the plugin
41+
42+
# 4. Install resource pack (optional but recommended)
43+
# Install the provided resource pack and datapack to the server
44+
```
45+
46+
## 📦 Core Features
47+
48+
### EMC System
49+
The core of ProjectE is the EMC (Energy-Matter Covalence) system. Players can break down items into EMC and use EMC to create new items.
50+
51+
### Transmutation Table
52+
Use the Transmutation Table to convert learned items to each other, consuming only the corresponding EMC.
53+
54+
### Energy Collector
55+
Automatically collects energy from sunlight to charge Klein Stars.
56+
57+
### Alchemical Devices
58+
Includes various practical devices such as Energy Condenser, Alchemical Chest, Dark Matter Furnace, and more.
59+
60+
## 🎮 Main Items
61+
62+
- **Philosopher's Stone**: Core tool for item conversion and crafting
63+
- **Klein Star**: Container for storing EMC
64+
- **Alchemical Bag**: Portable storage container
65+
- **Dark Matter Tools**: Powerful tool set
66+
- **Red Matter Tools**: Even more powerful tool set
67+
- **Gem Armor**: Armor providing special abilities
68+
69+
## 📊 Version Information
70+
71+
- **Current Version**: 1.2.4
72+
- **Supported Minecraft Versions**: 1.16.5 - 1.21+
73+
- **Dependencies**: Spigot/Paper server
74+
75+
## 🤝 Community Support
76+
77+
If you encounter problems during use, you can:
78+
79+
- Check the [complete documentation](/en/guide/)
80+
- Submit an [Issue](https://github.com/Little100/ProjectE-plugin/issues)
81+
- Join our community discussion
82+
83+
## 📝 Changelog
84+
85+
Check

0 commit comments

Comments
 (0)