diff --git a/.gitignore b/.gitignore index 9cc74938..9fa659f3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ Data/Logs -throttle.log \ No newline at end of file +throttle.log +**/Source/obj/** diff --git a/Data/System/Source/README b/Data/System/Source/README deleted file mode 100644 index 77ad98d0..00000000 --- a/Data/System/Source/README +++ /dev/null @@ -1,3 +0,0 @@ -To compile the source, use powershell and go into the Server directory and then run the below command: - -C:\Windows\Microsoft.NET\Framework64\v4.0.30319\csc /optimize /unsafe /t:exe /out:World.exe /win32icon:Source\icon.ico /d:NEWTIMERS /d:NEWPARENT /recurse:*.cs \ No newline at end of file diff --git a/Data/System/Source/README.md b/Data/System/Source/README.md new file mode 100644 index 00000000..6c7b5dbc --- /dev/null +++ b/Data/System/Source/README.md @@ -0,0 +1,23 @@ +Simple guide for compiling `World.exe` based on system. + +## Compiling on Windows + +Ensure [.NET Framework 4.0](https://dotnet.microsoft.com/en-us/download/dotnet-framework/net40) is installed. + +* Launch `PowerShell` via the Start Menu +* Navigate to the SoS repo's `System` directory + +``` +C:\Windows\Microsoft.NET\Framework64\v4.0.30319\csc /optimize /unsafe /t:exe /out:World.exe /win32icon:Source\icon.ico /d:NEWTIMERS /d:NEWPARENT /recurse:Source\*.cs +``` + +## Compiling on macOS + +Ensure [dotnet](https://formulae.brew.sh/formula/dotnet) is installed via [Homebrew](https://brew.sh/). + +* Launch `Terminal.app` via Spotlight +* Navigate to the SoS repo's `System\Source` directory + +``` +dotnet build +``` diff --git a/Data/System/Source/Source.csproj b/Data/System/Source/Source.csproj new file mode 100644 index 00000000..b9790d46 --- /dev/null +++ b/Data/System/Source/Source.csproj @@ -0,0 +1,24 @@ + + + Exe + World + ../../../ + icon.ico + false + none + true + true + true + win-x64 + false + false + net4.0 + enable + enable + true + preview + false + false + false + + diff --git a/README.md b/README.md index 89d96a73..e85367df 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,13 @@ For instructions, see [Manual.pdf](Manual.pdf). +Advanced compiling instructions can be found in [README.md](Data/System/Source/README.md). + # Secrets of Sosaria - Vision Statement Secrets of Sosaria is an enhanced fork of the Ruins & Riches (later continued as Adventurers of Akalabeth) project. We aim to continue the tradition of this project while also introducing improvements and additional content where we feel it would enhance the experience. Our main goals are as follows: -[Short Term Goals] +### Short Term Goals - Preservation and continuation of the core Ruins & Riches/Adventurers of Akalabeth experience. The "core experience" includes basic gameplay, game world setting, and lore. - Fixing long-standing bugs. @@ -14,18 +16,18 @@ Secrets of Sosaria is an enhanced fork of the Ruins & Riches (later continued as - Improvements to game systems, especially where we can increase the appeal of interacting with ones that weren't fully fleshed out, or which were made to feel redundant by other aspects of the game. - Identifying and reworking instances of "hostile design" that only provide tedium to the player instead of a sense of accomplishment. -[Long Term Goals] +### Long Term Goals - The introduction of new content that fits the aesthetic and themes of the game world. -[Target Audience] +### Target Audience The target audience is new players who are interested in an experience that takes its inspiration from tabletop roleplaying games as well as classic computer RPGs of the 1980s and 1990s. Additionally, it is intended for former players of Ruins & Riches and any of its previous forks who would like to play something further refined as a more streamlined, player-friendly, bugfixed and, eventually, more content-rich version of the game that they've come to love. -[Why Choose Secrets of Sosaria?] +### Why Choose Secrets of Sosaria? The source for our world package is freely available on github and we are open to taking suggestions from the community and potentially implementing them, so long as they align with our vision. We frequently update the game, and we have a friendly and growing community of players both on our live server (Multiverset) as well as those who play their own personal solo servers. -[Conclusion] +### Conclusion We seek to honor the legacy of the original developers and caretakers of this game while also making it a more engaging, cohesive, and most importantly fun experience for all. While we are just one fork among many of this project, we wish to provide the best possible user experience through utilizing the methods outlined in our goals.