Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added project files to support compiling via "dotnet build" on macOS #177

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
Data/Logs
throttle.log
throttle.log
**/Source/obj/**
3 changes: 0 additions & 3 deletions Data/System/Source/README

This file was deleted.

23 changes: 23 additions & 0 deletions Data/System/Source/README.md
Original file line number Diff line number Diff line change
@@ -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
```
24 changes: 24 additions & 0 deletions Data/System/Source/Source.csproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<AssemblyName>World</AssemblyName>
<OutputPath>../../../</OutputPath>
<ApplicationIcon>icon.ico</ApplicationIcon>
<DebugSymbols>false</DebugSymbols>
<DebugType>none</DebugType>
<PublishReadyToRun>true</PublishReadyToRun>
<PublishSingleFile>true</PublishSingleFile>
<IncludeSymbolsInSingleFile>true</IncludeSymbolsInSingleFile>
<RuntimeIdentifier>win-x64</RuntimeIdentifier>
<AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
<AppendRuntimeIdentifierToOutputPath>false</AppendRuntimeIdentifierToOutputPath>
<TargetFramework>net4.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<LangVersion>preview</LangVersion>
<Deterministic>false</Deterministic>
<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
<GenerateSupportedRuntime>false</GenerateSupportedRuntime>
</PropertyGroup>
</Project>
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,32 @@

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.
- Fixing inconsistencies with how parts of the game function, especially when that affects player experience.
- 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.