https://github.com/hanabi1224/scrolloftaiwumods

Mod development repository for steam game scroll of taiwu
https://github.com/hanabi1224/scrolloftaiwumods

Last synced: 6 months ago
JSON representation

Mod development repository for steam game scroll of taiwu

• Host: GitHub
• URL: https://github.com/hanabi1224/scrolloftaiwumods
• Owner: hanabi1224
• License: mit
• Created: 2020-11-21T08:31:47.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-07T08:59:41.000Z (over 2 years ago)
• Last Synced: 2025-02-13T11:33:07.417Z (8 months ago)
• Language: C#
• Size: 28.8 MB
• Stars: 0
• Watchers: 1
• Forks: 3
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ScrollOfTaiwuMods

[![Main](https://github.com/hanabi1224/ScrollOfTaiwuMods/actions/workflows/dotnet.yml/badge.svg)](https://github.com/hanabi1224/ScrollOfTaiwuMods/actions/workflows/dotnet.yml)

[![MIT License](https://img.shields.io/github/license/hanabi1224/ScrollOfTaiwuMods.svg)](https://github.com/hanabi1224/ScrollOfTaiwuMods/blob/master/LICENSE)

========

Mod development repository for steam game scroll of taiwu. 

Once code is merged into main branch, it will automatically deploy mod packages to this [site](https://taiwumods.vercel.app/)

## Development environment setup

* Install [.NET Framework 4.7.2 Developer Pack](https://dotnet.microsoft.com/download/dotnet-framework/net472)  ([Direct download link](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net472-developer-pack-offline-installer))

* Install [Visual Studio 2019 Community Edition](https://visualstudio.microsoft.com/zh-hans/downloads/) (Prefered IDE, lightweight ones like VS code also works)

* **And that is ALL. No other setup is needed, good to go now.**

## Build from IDE

* Double click on ScrollOfTaiwuMods.sln (Once VS2019 has been installed)

* devenv ScrollOfTaiwu.sln (Run VS2019 from command line)

## Build all mods from command line

* dotnet build -c Release

## Build single mod from command line

* dotnet build Mods/HelloWorld -c Release

## Publishing mod packages

* Once release build is performed successfully on certain mod projects, it automatically generate mod package under _publish folder (**Note that debug build does not publish mod package to _publish folder**).

* Once PR is merge into **main** branch, generated mod packages will be published to this [site](https://taiwumods.vercel.app/) automatically.

* Automatic update detection is enabled for UnityModManager during packaging so that mod users will be notified when new versions of mods are published.