Skip to content

Commit 98108aa

Browse files
DreamBoxSpyDreamBoxSpy
committed
first commit
0 parents  commit 98108aa

19 files changed

+18208
-0
lines changed

‎.gitignore‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎README.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Website
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
## Installation
6+
7+
```bash
8+
yarn
9+
```
10+
11+
## Local Development
12+
13+
```bash
14+
yarn start
15+
```
16+
17+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18+
19+
## Build
20+
21+
```bash
22+
yarn build
23+
```
24+
25+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
## Deployment
28+
29+
Using SSH:
30+
31+
```bash
32+
USE_SSH=true yarn deploy
33+
```
34+
35+
Not using SSH:
36+
37+
```bash
38+
GIT_USER=<Your GitHub username> yarn deploy
39+
```
40+
41+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

‎docs/intro.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# 介绍
6+
7+
![GitHub License](https://img.shields.io/github/license/dead-cells-core-modding/core) [![Build And Test](https://github.com/dead-cells-core-modding/core/actions/workflows/build.yml/badge.svg?branch=dev)](https://github.com/dead-cells-core-modding/core/actions/workflows/build.yml)
8+
9+
Dead Cells Core Modding（简称 DCCM ）是一个非官方的Mod框架，旨在提供对游戏更深入的修改。
10+
11+
:::warning
12+
DCCM 目前仅支持 Steam 平台的 Windows 版本
13+
:::

‎docs/tutorial/_category_.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"label": "教程",
3+
"position": 3,
4+
"link": {
5+
"type": "generated-index"
6+
}
7+
}

‎docs/tutorial/img/{D0E4CA71-3773-4DED-9C08-A8ABF9B6E9D9}.png‎

6.61 KB
Loading

‎docs/tutorial/install-core.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# 安装 DCCM 核心
6+
7+
## 先决条件
8+
9+
- **.NET 9 运行时**
10+
- **Microsoft Visual C++ 可再发行组件包 (2015-2022)**
11+
12+
:::info
13+
如果你打算开发用于 **DCCM** 的 **Mods** ， 请额外安装 **.NET 9 SDK**。
14+
:::
15+
16+
## 安装
17+
18+
### 获取DCCM核心
19+
20+
你可以从 [Github Releases](https://github.com/dead-cells-core-modding/core/releases/latest) 页面下载最新的DCCM核心。
21+
22+
如果你希望使用尚未正式发布的新功能，[这个](https://nightly.link/dead-cells-core-modding/core/workflows/build/dev)可能更适合你。
23+
24+
### 安装 DCCM 核心文件
25+
26+
从文件管理器中打开游戏根目录，创造一个名为 `coremod` 的文件夹。将上一步获取的DCCM核心文件解压至文件夹中。
27+
28+
完成以上操作后，目录结构应该像这样：
29+
30+
```txt
31+
<DeadCellsGameRoot>
32+
├─ coremod
33+
│ ├─ core
34+
│ │ ├─ native
35+
│ │ │ └─ …
36+
│ │ ├─ mdk
37+
│ │ │ ├─ install.ps1
38+
│ │ │ ├─ uninstall.ps1
39+
│ │ │ └─ …
40+
│ │ ├─ host
41+
│ │ │ ├─ startup
42+
│ │ │ │ ├─ DeadCellsModding.exe
43+
│ │ │ │ └─ …
44+
│ │ │ └─ …
45+
│ │ └─ …
46+
│ └─ …
47+
├─ deadcells.exe
48+
├─ deadcells_gl.exe
49+
└─ …
50+
```
51+
52+
:::tip
53+
如果你愿意，你可以把 `DeadCellsModding.exe` 文件复制到游戏根目录下。
54+
:::
55+
56+
## 启动游戏
57+
58+
当完成以上操作后，就可以通过 `DeadCellsModding.exe` 启动修改后的游戏。
59+
60+
:::warning
61+
首次安装或更新后，**首次启动**可能需要较长时间生成缓存（内存占用较高）。
62+
:::
63+
64+
如果一切顺利，那么游戏主菜单左下角将会显示 **DCCM** 的版本号。
65+
66+
![DCCM](img/{D0E4CA71-3773-4DED-9C08-A8ABF9B6E9D9}.png)

‎docs/tutorial/install-mods.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# 安装 Mods
6+
7+
:::info
8+
本文所提到的 **Mods 目录** 的路径为`<DeadCellsGameRoot>/coremod/mods`。
9+
:::
10+
11+
## 获取 Mods
12+
13+
你可以从任何你喜欢的渠道获取 **Mods**。
14+
对于任何一个**有效**的 Mod ，其目录结构应该类似：
15+
16+
```txt
17+
<Mod根目录>
18+
```

‎docusaurus.config.js‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
// @ts-check
2+
// `@type` JSDoc annotations allow editor autocompletion and type checking
3+
// (when paired with `@ts-check`).
4+
// There are various equivalent ways to declare your Docusaurus config.
5+
// See: https://docusaurus.io/docs/api/docusaurus-config
6+
7+
import {themes as prismThemes} from 'prism-react-renderer';
8+
9+
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
10+
11+
/** @type {import('@docusaurus/types').Config} */
12+
const config = {
13+
title: 'Dead Cells Core Modding文档',
14+
tagline: '',
15+
favicon: 'img/favicon.ico',
16+
17+
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
18+
future: {
19+
v4: true, // Improve compatibility with the upcoming Docusaurus v4
20+
},
21+
22+
// Set the production url of your site here
23+
url: 'https://dead-cells-core-modding.github.io',
24+
// Set the /<baseUrl>/ pathname under which your site is served
25+
// For GitHub pages deployment, it is often '/<projectName>/'
26+
baseUrl: '/docs-zh/',
27+
28+
// GitHub pages deployment config.
29+
// If you aren't using GitHub pages, you don't need these.
30+
organizationName: 'dead-cells-core-modding', // Usually your GitHub org/user name.
31+
projectName: 'core', // Usually your repo name.
32+
33+
onBrokenLinks: 'throw',
34+
onBrokenMarkdownLinks: 'warn',
35+
36+
// Even if you don't use internationalization, you can use this field to set
37+
// useful metadata like html lang. For example, if your site is Chinese, you
38+
// may want to replace "en" with "zh-Hans".
39+
i18n: {
40+
defaultLocale: 'zh',
41+
locales: ['zh'],
42+
},
43+
44+
presets: [
45+
[
46+
'classic',
47+
/** @type {import('@docusaurus/preset-classic').Options} */
48+
({
49+
docs: {
50+
sidebarPath: './sidebars.js',
51+
// Please change this to your repo.
52+
// Remove this to remove the "edit this page" links.
53+
editUrl:
54+
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
55+
},
56+
blog: {
57+
showReadingTime: true,
58+
feedOptions: {
59+
type: ['rss', 'atom'],
60+
xslt: true,
61+
},
62+
// Please change this to your repo.
63+
// Remove this to remove the "edit this page" links.
64+
editUrl:
65+
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
66+
// Useful options to enforce blogging best practices
67+
onInlineTags: 'warn',
68+
onInlineAuthors: 'warn',
69+
onUntruncatedBlogPosts: 'warn',
70+
},
71+
}),
72+
],
73+
],
74+
75+
themeConfig:
76+
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
77+
({
78+
// Replace with your project's social card
79+
image: 'img/docusaurus-social-card.jpg',
80+
navbar: {
81+
title: 'Dead Cells Core Modding文档',
82+
items: [
83+
{
84+
type: 'docSidebar',
85+
sidebarId: 'tutorialSidebar',
86+
position: 'left',
87+
label: '教程',
88+
},
89+
],
90+
},
91+
footer: {
92+
style: 'dark',
93+
links: [
94+
{
95+
title: '文档',
96+
items: [
97+
{
98+
label: '教程',
99+
to: '/docs/intro',
100+
},
101+
],
102+
},
103+
{
104+
title: '社区',
105+
items: [
106+
{
107+
label: 'Discord',
108+
href: 'https://discord.gg/deadcells',
109+
},
110+
],
111+
},
112+
{
113+
title: '更多',
114+
items: [
115+
{
116+
label: 'GitHub',
117+
href: 'https://github.com/dead-cells-core-modding/core',
118+
},
119+
],
120+
},
121+
],
122+
copyright: `Built with Docusaurus.`,
123+
},
124+
prism: {
125+
theme: prismThemes.github,
126+
darkTheme: prismThemes.dracula,
127+
},
128+
}),
129+
};
130+
131+
export default config;

0 commit comments

Comments
 (0)