mirrors/OpenTS2
1
0
Fork 0
mirror of https://github.com/LazyDuchess/OpenTS2.git synced 2025-01-22 16:21:47 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
OpenTS2/README.md

52 lines
3.4 KiB
Markdown
Raw Normal View History

Create README.md
2022-04-29 08:01:53 -04:00
<h1 align="center">OpenTS2</h1>
Update README.md
2022-04-29 09:05:37 -04:00
OpenTS2 is an Open-Source Reimplementation of The Sims 2, using the Unity game engine. Also aims to provide a number of modular libraries for working with TS2 formats in a C# environment.
Create README.md
2022-04-29 08:01:53 -04:00
## Progress
Update README.md
2023-07-19 00:01:57 -04:00
Currently a basic main menu with a neighborhood chooser is implemented. Neighborhood info can be previewed and a basic neighborhood view can be accessed.
screenshot in readme
2023-07-31 17:42:31 -04:00
![image](https://github.com/LazyDuchess/OpenTS2/assets/42678262/7ec4b21f-8987-41e6-b780-cca694698354)
Create README.md
2022-04-29 08:01:53 -04:00
Update README.md
2022-04-29 08:09:53 -04:00
## Acknowledgements
* [InvertedTomato.CRC](https://github.com/invertedtomato/crc)
Update README.md
2022-05-01 22:23:51 -04:00
* [TGA Image Reader](https://www.codeproject.com/Articles/31702/NET-Targa-Image-Reader)
Update README.md
2023-05-29 22:51:06 -04:00
* [Hardware Cursor Plugin](https://forum.unity.com/threads/hardware-cursor-plugin.70163/)
add moonsharp to acknowledgments
2023-08-28 14:05:55 -04:00
* [MoonSharp](https://github.com/moonsharp-devs/moonsharp/)
Replace our compression with DBPFSharp's
2023-08-30 01:36:43 -04:00
* [FreeSO](https://github.com/RHY3756547/FreeSO)
Fix formatting in README
2023-08-30 01:38:34 -04:00
* [DBPFSharp](https://github.com/0xC0000054/DBPFSharp/blob/main/src/DBPFSharp)
Update README.md
2022-04-29 08:09:53 -04:00
Create README.md
2022-04-29 08:01:53 -04:00
## Similar Projects
* [FreeSO](https://github.com/RHY3756547/FreeSO) - Open Source reimplementation of The Sims Online using C# and Monogame. OpenTS2 borrows a lot of code and structure from this project.
* [Las Marionetas](https://github.com/OmniBlade/LasMarionetas) - Similar project, aiming to reimplement The Sims 2 by reverse engineering its binary code into C/C++ source code.
Update README.md
2022-04-29 08:09:53 -04:00
* [SimUnity2](https://github.com/LazyDuchess/SimUnity2) - Earlier attempt at a TS2 reimplementation in the Unity engine. Abandoned, succeeded by this project.
Update README.md
2022-04-29 13:00:25 -04:00
* [OpenTPW](https://github.com/ThemeParkWorld/OpenTPW) - Open Source reimplementation of Sim Theme Park / Theme Park World.
* [OpenRCT2](https://github.com/OpenRCT2/OpenRCT2) - Open Source reimplementation of Rollercoaster Tycoon 2.
Create README.md
2022-04-29 08:01:53 -04:00
## License
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
Add unit tests through unity test runner As per the unity guide, this requires creating an assembly that depends on the `nunit.framework.dll` reference. In order to allow this testing assembly to access the code under the OpenTS2 folder, we create a `ScriptsAssembly` assembly that the `Tests` assembly can depend on. Unfortunately these tests can only be run through unity or the Rider IDE but unless we want to do a clean separation of all the Unity bits from the C# code this will likely be the easiest option.
2022-12-07 14:43:03 -05:00
# Development
## Prerequisites
* [Unity 2020.3.32f1](https://unity3d.com/get-unity/download/archive) - Can be found under "Unity 2020.x", you could also download the Unity Hub and install from there. Unity version is subject to change, please keep an eye on this!
* [Visual Studio 2019](https://visualstudio.microsoft.com/vs/)
* A copy of The Sims 2 Ultimate Collection
## Setup
Updated README to include basic Unity setup.
2023-01-26 23:21:53 -05:00
1. You need to have a "config.json" file in the root folder that provides paths to your Sims 2 UC installation and user directories. Copy the "config.example.json" file and rename it to "config.json" to start off, and type in your own paths.
2. In Unity, make sure Edit > Preferences > External Tools > External Script Editor is set to Visual Studio. By default it opens files separately as opposed to in a solution.
Add unit tests through unity test runner As per the unity guide, this requires creating an assembly that depends on the `nunit.framework.dll` reference. In order to allow this testing assembly to access the code under the OpenTS2 folder, we create a `ScriptsAssembly` assembly that the `Tests` assembly can depend on. Unfortunately these tests can only be run through unity or the Rider IDE but unless we want to do a clean separation of all the Unity bits from the C# code this will likely be the easiest option.
2022-12-07 14:43:03 -05:00
## Project Structure
We follow the layout of a normal Unity project except:
* `Assets/Scripts/OpenTS2` - Contains the bulk of the C# code that deals with TS2 formats and files.
* `Assets/Scripts/OpenTS2/Engine` - Unity *specific* code tends to live in here to keep it
Update README.md
2022-12-21 05:28:17 -05:00
separate from the more language-independent code in the directory.
Add unit tests through unity test runner As per the unity guide, this requires creating an assembly that depends on the `nunit.framework.dll` reference. In order to allow this testing assembly to access the code under the OpenTS2 folder, we create a `ScriptsAssembly` assembly that the `Tests` assembly can depend on. Unfortunately these tests can only be run through unity or the Rider IDE but unless we want to do a clean separation of all the Unity bits from the C# code this will likely be the easiest option.
2022-12-07 14:43:03 -05:00
* `Assets/Tests/OpenTS2/` - Unit tests following the same directory structure as the `Scripts` folder.
## Testing
Changed link for documentation of Unity Unit Tester from 2017.4 to 2020.3
2023-01-24 09:17:45 -05:00
We currently use the [Unity Test Runner](https://docs.unity3d.com/2020.3/Documentation/Manual/testing-editortestsrunner.html)
Add unit tests through unity test runner As per the unity guide, this requires creating an assembly that depends on the `nunit.framework.dll` reference. In order to allow this testing assembly to access the code under the OpenTS2 folder, we create a `ScriptsAssembly` assembly that the `Tests` assembly can depend on. Unfortunately these tests can only be run through unity or the Rider IDE but unless we want to do a clean separation of all the Unity bits from the C# code this will likely be the easiest option.
2022-12-07 14:43:03 -05:00
for unit testing code. These tests can be run inside of unity through the test runner tab or if you use Rider as your C#
editor, inside of it.
Reference in a new issue Copy permalink