Skip to content

Commit 2e60f1b

Browse files
hozukihozuki
committed
Release preparations.
1 parent c785349 commit 2e60f1b

File tree

5 files changed

+86
-71
lines changed

5 files changed

+86
-71
lines changed

‎MilliSim.sln

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,11 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MonoGame.Extended.Overlay",
5757
EndProject
5858
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OpenMLTD.MilliSim.Contributed.Scores", "src\OpenMLTD.MilliSim.Contributed.Scores\OpenMLTD.MilliSim.Contributed.Scores.csproj", "{C596B23A-77B3-430C-85C1-3D7AB6BCA658}"
5959
EndProject
60+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{A9812921-52BA-4551-91F8-BE2766E6F6B0}"
61+
ProjectSection(SolutionItems) = preProject
62+
docs\Building.md = docs\Building.md
63+
EndProjectSection
64+
EndProject
6065
Global
6166
GlobalSection(SolutionConfigurationPlatforms) = preSolution
6267
Debug|Any CPU = Debug|Any CPU
@@ -210,6 +215,7 @@ Global
210215
{22AEEF23-15FF-4B6C-941D-550C63F50329} = {6F1F41CA-26AC-4D95-9D49-3D07F3200429}
211216
{B33715B5-4EA1-4088-8E9A-B6DC033D2DCE} = {6F1F41CA-26AC-4D95-9D49-3D07F3200429}
212217
{8A716D2A-DE8D-4886-BF8F-76B6B1A7BB8F} = {700A876B-F712-44FC-9513-CC1B6096D5FF}
218+
{A9812921-52BA-4551-91F8-BE2766E6F6B0} = {9D3D7DAF-5C06-4EDF-A6FA-7A22B9924F0D}
213219
EndGlobalSection
214220
GlobalSection(ExtensibilityGlobals) = postSolution
215221
SolutionGuid = {27A82ED7-C1EE-4F03-B3AD-02534ACDB2B1}

‎README.md

Lines changed: 19 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Demo videos:
1414

1515
| Build Status | |
1616
|--|--|
17-
| Travis | [![Travis](https://img.shields.io/travis/hozuki/MilliSim.svg)](https://travis-ci.org/hozuki/MilliSim) |
17+
| <del>Travis</del> (not maintained) | [![Travis](https://img.shields.io/travis/hozuki/MilliSim.svg)](https://travis-ci.org/hozuki/MilliSim) |
1818
| AppVeyor | [![AppVeyor](https://img.shields.io/appveyor/ci/hozuki/MilliSim.svg)](https://ci.appveyor.com/project/hozuki/MilliSim) |
1919

2020
**Stage:** alpha
@@ -29,87 +29,37 @@ Demo videos:
2929

3030
**Requirements:**
3131

32-
- Windows 7 SP1 or later <sup>1 2</sup>
33-
- [.NET Framework 4.5](https://www.microsoft.com/en-us/download/details.aspx?id=42642)
32+
- Operating System:
33+
- Windows: Windows 7 SP1 or later
34+
- [.NET Framework 4.5](https://www.microsoft.com/en-us/download/details.aspx?id=42642)
35+
- macOS and Linux: macOS 10.8 / Ubuntu 16.04 or later
36+
- and latest [Wine](https://wiki.winehq.org/Download) (will download `wine-mono` on launch)
3437
- [Visual C++ 2015 Runtime](https://www.microsoft.com/en-us/download/details.aspx?id=53587)
35-
- Direct3D 11 and Direct2D
36-
- For Windows 7 SP1 users:
37-
- [Platform Update for Windows 7](https://www.microsoft.com/en-us/download/details.aspx?id=36805)
3838
- [OpenAL](https://www.openal.org/downloads/)
3939

40-
After downloading, run `OpenMLTD.MilliSim.Theater.exe` and enjoy.
40+
OpenGL builds (`TheaterDays.OpenGL.exe`) can run on all platforms, but it is problematic.
41+
DirectX builds (`TheaterDays.Direct3D11.exe`) can only run on Windows.
4142

42-
<sup>1</sup> <del>Theoratically, MilliSim can also run on a UNIX-compliant machine using [Wine](https://www.winehq.org/download)
43-
and [Mono](http://www.mono-project.com/download/), though this is not tested.</del> Tested
44-
on Wine 2.0.2. Media Foundation APIs and WAS APIs are still having tons of errors. Even after
45-
bypassing OS version check (Wine seems to always return an OS major version less than 6),
46-
`MMDeviceEnumerator` still fails to initialize due to COM object creation failure. `MFCreateDxgiDeviceManager()`
47-
is just a stub. So up till September 2017, MilliSim is only able to run on Windows.
43+
### Note: Video Playback Support
4844

49-
<sup>2</sup> Playing a background video is not yet (version: v0.2) supported on Windows 7. It is
50-
supported on Windows 8 or later.
45+
If you want to play videos as the background, you must download FFmpeg binaries (version 3.4.1 or later)
46+
from [here](https://ffmpeg.zeranoe.com/builds/), and place the binaries into `x64` and `x86` directories
47+
correspondingly. Due to license restrictions, MilliSim builds cannot include FFmpeg binaries, so you have
48+
to download them yourself.
5149

52-
## Building
53-
54-
**Requirements:**
55-
56-
- OS: Windows, macOS or Linux
57-
- Compiler and Toolchain:
58-
- Windows:
59-
- Visual Studio 2017 Community
60-
- .NET Framework 4.5 Toolchain
61-
- macOS/Linux:
62-
- [Mono](http://www.mono-project.com/download/) (≥ 5.0)
63-
- [Node.js](https://nodejs.org/en/download/) (≥ 5.0)
64-
- [NuGet CLI](https://www.nuget.org/downloads) (≥ 4.3.0)
65-
66-
> **Remember** to [update your Mono version](http://www.mono-project.com/download/#download-lin) and
67-
> [update your NuGet version](https://docs.microsoft.com/en-us/nuget/guides/install-nuget) before
68-
> building. Otherwise you are very likely to see errors like "Too many projects specified".
69-
70-
**Step 1**: Clone this repo:
71-
72-
```bash
73-
git clone https://github.com/hozuki/MilliSim.git
74-
```
75-
76-
**Step 2**: Prepare dependencies:
50+
Without FFmpeg, you must either:
7751

78-
On Windows:
52+
1. disable background video (comment out `plugin.component_factory.background_video` in `Contents/plugins.yml`), or
53+
2. leave video file path as empty (`data`-`video` section in `Contents/config/background_video.yml`).
7954

80-
```cmd
81-
cd MilliSim
82-
init
83-
```
84-
85-
On macOS and Linux:
86-
87-
```bash
88-
cd MilliSim
89-
./init.sh
90-
```
91-
92-
**Step 3**: Build the solution:
93-
94-
```bash
95-
msbuild MilliSim.sln /p:Configuration=Release
96-
```
97-
98-
If you are using non-Windows machines, you should
99-
manually specify the concurrent process count, or
100-
there will be strange compile errors:
101-
102-
```bash
103-
msbuild MilliSim.sln /p:Configuration=Release /m:1
104-
```
55+
## Building
10556

106-
Although the builds by Travis seem unable to bootstrap on Windows,
107-
manual builds on an Ubuntu 16.04 machine are verified to function
108-
normally.
57+
Please read [Building.md](docs/Building.md).
10958

11059
## Developing Plugins
11160

11261
MilliSim is designed to support plugins. Please read the [wiki page](https://github.com/hozuki/MilliSim/wiki/Creating-Plugins) for more information.
62+
(Note: this is mainly about version 0.2 so it may be deprecated. Proceed with caution. Help is appreciated!)
11363

11464
You can find precompiled NuGet packages for plugin development [here](https://www.nuget.org/packages?q=MilliSim).
11565

‎docs/Building.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Building MilliSim
2+
3+
**Requirements:**
4+
5+
- OS: Windows, macOS or Linux
6+
- Compiler and Toolchain:
7+
- Windows:
8+
- Visual Studio 2017 Community
9+
- .NET Framework 4.5 Toolchain
10+
- macOS/Linux:
11+
- [Mono](http://www.mono-project.com/download/) (≥ 5.0)
12+
- [Node.js](https://nodejs.org/en/download/) (≥ 5.0)
13+
- [NuGet CLI](https://www.nuget.org/downloads) (≥ 4.3.0)
14+
15+
> **Remember** to [update your Mono version](http://www.mono-project.com/download/#download-lin) and
16+
> [update your NuGet version](https://docs.microsoft.com/en-us/nuget/guides/install-nuget) before
17+
> building. Otherwise you are very likely to see errors like "Too many projects specified".
18+
19+
**Step 1**: Clone this repo:
20+
21+
```bash
22+
git clone https://github.com/hozuki/MilliSim.git
23+
```
24+
25+
**Step 2**: Prepare dependencies:
26+
27+
First, install [MonoGame](http://www.monogame.net/downloads/) (version 3.6 or later).
28+
29+
Then, on Windows:
30+
31+
```cmd
32+
cd MilliSim
33+
init
34+
```
35+
36+
On macOS and Linux:
37+
38+
```bash
39+
cd MilliSim
40+
./init.sh
41+
```
42+
43+
**Step 3**: Build the solution:
44+
45+
```bash
46+
msbuild MilliSim.sln /p:Configuration=Release
47+
```
48+
49+
If you are using non-Windows machines, you should
50+
manually specify the concurrent process count, or
51+
there will be strange compile errors:
52+
53+
```bash
54+
msbuild MilliSim.sln /p:Configuration=Release /m:1
55+
```
56+
57+
Although the builds by Travis seem unable to bootstrap on Windows,
58+
manual builds on an Ubuntu 16.04 machine are verified to function
59+
normally.

‎push.cmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
@REM "git push --follow-tags" does not trigger AppVeyor to build correctly.
2-
@git push --tags
32
@git push
3+
@git push --tags

‎push.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#!/bin/bash
2-
git push --tags
32
git push
3+
git push --tags

0 commit comments

Comments
 (0)