Skip to content

Commit

Permalink
Merge pull request #92 from lZiMUl/test
Browse files Browse the repository at this point in the history
Test
  • Loading branch information
lZiMUl authored Sep 26, 2024
2 parents 5539931 + 37668d8 commit f9218c1
Show file tree
Hide file tree
Showing 31 changed files with 909 additions and 309 deletions.
120 changes: 60 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# mcwl4w

mcwl4w 是一个旨在通过在线网站为Minecraft服务器提供便捷白名单申请的项目。
它允许玩家通过简单的网页表单提交他们的申请信息,如用户名、邮箱等,这一项目旨在提升服务器管理的效率,同时优化玩家的游戏体验,确保只有符合要求的玩家能够加入服务器。
mcwl4w is a project designed to provide a convenient whitelist application for Minecraft servers through an online website. It allows players to submit their application information, such as username and email, via a simple web form. This project aims to enhance server management efficiency while optimizing the gaming experience for players, ensuring that only eligible players can join the server.

## Browser Support

Expand All @@ -11,22 +10,22 @@ mcwl4w 是一个旨在通过在线网站为Minecraft服务器提供便捷白名

<br />

<p align="center">
<div align="center">
<a href="https://github.com/lZiMUl/mcwl4w/">
<img src="/assets/image/icon/logo.png" alt="Logo" width="120" height="120">
</a>

<h3 align="center">mcwl4w</h3>
<p align="center">
<br />
<a href="https://github.com/lZiMUl/mcwl4w"><strong>探索本项目的文档 »</strong></a>
<a href="https://github.com/lZiMUl/mcwl4w"><strong>Explore the documentation for this project »</strong></a>
<br />
<br />
<a href="https://github.com/lZiMUl/mcwl4w/issues">报告Bug</a>
<a href="https://github.com/lZiMUl/mcwl4w/issues">Report Bugs</a>
·
<a href="https://github.com/lZiMUl/mcwl4w/issues">提出新特性</a>
<a href="https://github.com/lZiMUl/mcwl4w/issues">Propose New Features</a>
</p>
</p>
</div>

[![BiliBili][bilibili-shield]][bilibili-url]
[![Contributors][contributors-shield]][contributors-url]
Expand All @@ -36,120 +35,121 @@ mcwl4w 是一个旨在通过在线网站为Minecraft服务器提供便捷白名
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]

## 功能
## [前往中文 README](./README_CN.md)

- **在线申请白名单**:玩家可以通过网站提交申请信息。
- **高效管理**:服务器管理员可以轻松管理和审核申请。
- **优化体验**:确保只有符合要求的玩家能够加入服务器。
## Features

## 预览图
- **Online Whitelist Application**:Players can submit their application information through the website.。
- **Efficient Management**:Server administrators can easily manage and review applications.
- **Optimized Experience**:Ensures that only eligible players can join the server.

## Preview Images

<img src="/assets/image/preview/preview1.png" alt="Logo" width="500" height="*">

<img src="/assets/image/preview/preview2.png" alt="Logo" width="500" height="*">

<img src="/assets/image/preview/preview3.png" alt="Logo" width="500" height="*">

## 安装
## Installation

1. **下载项目到本地**
1. **Download the project locally**
```bash
git clone https://github.com/lZiMUl/mcwl4w.git && cd mcwl4w
```

2. **项目依赖安装**
2. **Install project dependencies**
```bash
# 对于国外网络环境
# For foreign network environments
npm run install
# 对于国内网络环境
# For domestic network environments
npm run install:china
```

3. **更改项目配置文件**
3. **Modify the project configuration file**
```text
进入项目的 config 文件夹
修改 default.toml 里面的配置项
Enter the project's config folder
Modify the configuration items in default.toml
```
4. **编译项目**
4. **Compile the project**
```bash
npm run build
```
5. **运行项目**
5. **Run the project**
```bash
npm run start
```
## 使用

1. 访问网站首页。
2. 填写并提交白名单申请表单。
3. 管理员审核申请并更新白名单。

## 贡献
## Usage
1. Visit the homepage of the website.
2. Fill out and submit the whitelist application form.
3. The administrator reviews the application and updates the whitelist.
欢迎任何形式的贡献!请 fork 本项目并提交 pull request。
## Contribution
Contributions in any form are welcome! Please fork this project and submit a pull request.
## 许可证
## License
本项目基于 MIT 许可证开源。
This project is open-sourced under the MIT License.
## 联系
## Contact
如果有任何问题或建议,请联系 [lZiMUl@lzimul.com](mailto:lZiMUl@lzimul.com)。
If you have any questions or suggestions, please contact [lZiMUl@lzimul.com](mailto:lZiMUl@lzimul.com)。
#### 以下是默认配置, 配置出现问题, 可以复制过去哦 ;-)
#### Below is the default configuration. If you encounter any configuration issues, you can copy and paste it here ;-)
```toml
# 全局配置
# Global Configuration
[globalConfig]
# 网站标题
title = "Minecraft 服务器 - 白名单自助验证"
# 提示
contactContent = "加入QQ群"
# 群号
# Website Title
title = "Minecraft Server - Whitelist Self-Verification"
# Contact Prompt
contactContent = "Join Discord Group"
# Group Number
contactNumber = "123456789"
# 链接
contactLink = "https://qm.qq.com/q/123456789"
# Link
contactLink = "https://discord.com/"
# 网站服务配置
# Web Service Configuration
[webService]
# 主机
# Host
host = "0.0.0.0"
# 端口
port = 22
# 网站会话超时时间 (单位:分钟)
# Port
port = 80
# Website session timeout (unit: minutes)
sessionTimeout = 10
# 邮箱服务配置
# Email Service Configuration
[emailService]
# 主机
# Host
host = "smtp.gmail.com"
# 端口
# Port
port = 587
# 用户
# User
username = ""
# 密码
# Password
password = ""
# 验证码过期时间 (单位:分钟)
# Verification code expiration time (unit: minutes)
verifyCodeExpireTime = 5
# Rcon服务配置
# Rcon Service Configuration
[rconService]
# 主机
# Host
host = "127.0.0.1"
# 端口
# Port
port = 25575
# 密码
password = ""
# Password
password = ""
```
<!-- links -->
[your-project-path]:lZiMUl/mcwl4w
[bilibili-shield]: https://img.shields.io/badge/mcwl4w%20開發者B站-red?logo=bilibili
[bilibili-shield]: https://img.shields.io/badge/mcwl4w%20Developer%20Bilibili-red?logo=bilibili
[bilibili-url]: https://space.bilibili.com/291883246
Expand Down
Loading

0 comments on commit f9218c1

Please sign in to comment.