Skip to content

Latest commit

 

History

History
135 lines (103 loc) · 5.91 KB

README.zh.md

File metadata and controls

135 lines (103 loc) · 5.91 KB
Raw

MorePractice Malody Server

状态：

master
dev

基本

API版本：202103
程序版本：1.0.3 程序运行时：ASP.NET Core

开源的 Malody V 谱面(Chart)服务器。低负载基本能用，高负载肯定完蛋。
开箱即用的服务器程序，不需配置即可使用 sqlite 与本地文件系统主持服务器。

功能

目前已经实现的功能：

  • 谱面上传/下载
  • 谱面搜索（关键字/按id）
  • 谱面列表
  • 推荐列表
  • 自提供存储
  • 活动列表
  • MySql/SQLServer/sqlite支持

目前已知有bug的功能：

  • 一切正常 :)

目前未实现的功能：

  • 支持 202108 API版本

将在未来添加的功能：

  • 上传身份限制
  • 用户身份限制
  • 第三方存储提供
  • 支持 202108 API版本
  • 支持 docker
  • 前端管理界面

安装

可以用以下两种方式安装：二进制文件或从源代码编译

使用二进制文件安装：

  1. 在Release页面下载最新的二进制文件。
  2. 解压到本地，修改配置文件。
  3. 运行MorePracticeMalodyServer。根据平台不同，文件名略有差异。
  • Linux: MorePracticeMalodyServer
  • Windows: MorePracticeMalodyServer.exe

从源代码编译：

  1. 克隆或下载MorePracticeMalodyServer仓库。
  2. 确保已经安装.NET 5 SDK。您可以从此下载。关于如何安装.NET 5 SDK，您可以阅读此文章。
  3. 运行dotnet restore。
  4. 默认使用sqlite提供数据库，本地文件系统提供存储。若要使用其他提供程序，请参考修改配置章节。
  5. 若切换了数据库提供程序，请先删除 MorePracticeMalodyServer\Migrations 文件夹内所有内容。之后运行dotnet ef migrations add InitialCreate，执行完成后运行dotnet ef database update来更新数据库。对于生产数据库，建议运行dotnet ef migrations script --idempotent生成SQL脚本，在数据库上运行该脚本以构建数据表。
  6. 运行dotnet build --configuration Release --no-restore构建应用程序。
  7. 在 MorePracticeMalodyServer\bin\Release 下复制构建好的应用程序。

修改配置

应用程序配置是appsettings.json。该文件的结构以及修改方式如下：

  • Logging
    • LogLevel : 可全部设为Warning减少输出
      • Default
      • Microsoft
      • Microsoft.Hosting.Lifetime
    • Data : 数据库相关设置
      • Provider : 数据库提供程序，可设置为sqlserver,mysql,sqlite。默认为sqlite。
      • PoolSize : 连接池的最大连接数。
      • ConnectionString : 连接字符串，具体设置请参考数据库文档。
      • ServerVersion : MySql使用，确定服务器版本。
    • Storage : 存储提供程序相关配置
      • Provider : 存储提供程序的链接，self时为自提供。有关如何扩展存储提供，请参考自定义存储提供章节。

修改数据库提供程序的注意事项

如果您修改了数据库提供程序，您必须使用源代码编译的方式来生成数据库迁移以及数据库脚本，来构建您的数据表。
请参考安装中的从源代码编译部分进行操作。 由于目前程序仅测试了使用sqlite，因此其它提供程序可能会出现不可预料的行为。如果程序在您使用时发生异常，请提交Issue。

自定义存储提供

此部分目前尚未实现！
请将Storage:Provider设置为您的文件提供程序的上传接口。
上传完成后请调用服务器回调通知服务器文件的链接。（此回调尚未实现）
游戏使用application/x-www-form-urlencoded传送文件，每次只会发送一个文件，同时附带额外的meta信息。 meta信息为文本键值对。在程序中，我们提供了文件的cid，sid，hash数据，您可以在表单中检索。
由于文件在您的提供程序上保存，服务器不会尝试下载您的文件进行解析。您需要自行解析谱面文件(chart file | *.mc)的元数据。 解析过后请调用服务器API上传歌曲元数据。（此API尚未实现）

docker支持

程序支持在 docker 上运行。目前没有打包 docker 镜像，但是提供了 dockerfile ，因此需要您自行运行docker build进行构建。
在 docker 上运行的服务器不支持使用本地文件系统，也不支持使用sqlite。请替换数据库提供程序与存储提供程序。关于如何替换数据库提供程序与文件提供程序，请参考上文。

许可

本程序使用 GPL v3.0 (GNU GENERAL PUBLIC LICENSE v3.0)许可开放源代码，使用本程序或源代码即代表您了解并同意该协议。

Microsoft.EntityFrameworkCore

  • Apache-2.0

Microsoft.EntityFrameworkCore.Sqlite

  • Apache-2.0

Microsoft.EntityFrameworkCore.SqlServer

  • Apache-2.0

Microsoft.EntityFrameworkCore.Tools

  • Apache-2.0

Microsoft.VisualStudio.Azure.Containers.Tools.Targets

Pomelo.EntityFrameworkCore.MySql

  • MIT

NVorbis

  • Mit

感谢