Skip to content

Commit cd49f0b

Browse files
init
0 parents  commit cd49f0b

9 files changed

+676
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
dist/
2+
node_modules/

LICENSE

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright 2023 Captain-Of-Coit
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
all: build
2+
3+
install-ui-deps:
4+
@npm ci
5+
6+
bundle: install-ui-deps
7+
@node build.mjs
8+
9+
build: bundle
10+
@echo Build complete.
11+
12+
package-pwsh: build
13+
@powershell -Command "$$version = (Get-Content package.json | ConvertFrom-Json).version; Compress-Archive -Path './dist/city_monitor.transpiled.js' -DestinationPath \"./dist/release-$$version.zip\""
14+
15+
package-unix: build
16+
@version=$$(jq -r '.version' package.json); \
17+
zip ./dist/release-$$version.zip ./dist/city_monitor.transpiled.js

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# City Monitor for Cities: Skylines 2
2+
3+
Displays a little window so you can see the most important details of your city without having to open up any panels manually.
4+
5+
<video src="demo.mp4"></video>
6+
7+
Should display the following stats:
8+
9+
- Electricity availability
10+
- Water availability
11+
- Sewage treatment
12+
- Landfill usage
13+
- Incineration status
14+
- Healthcare availability
15+
- Average health
16+
- Cemetery usage
17+
- Crematorium availability
18+
- Fire hazard
19+
- Crime rate
20+
- Jail availability
21+
- Elementary school availability
22+
- High school availability
23+
- University availability
24+
- Employment rate
25+
26+
## Requirements
27+
28+
- Cities: Skylines 2
29+
- BepInEx-Unity.Mono-win-x64-6.0.0-be.674+82077ec
30+
- [HookUI 0.0.1](https://github.com/Captain-Of-Coit/hookui)
31+
32+
## Installation
33+
34+
- Download latest release.
35+
- Extract the ZIP archive
36+
- Place in "Cities2_Data\StreamingAssets\~UI~\HookUI\Extensions" directory, within your game directory

build.mjs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import * as esbuild from 'esbuild'
2+
3+
// Useful when developing the UI, as the Game UI reloads on changes
4+
// const outPath = 'C:\\Program Files (x86)\\Steam\\steamapps\\common\\Cities Skylines II\\Cities2_Data\\StreamingAssets\\~UI~\\HookUI\\Extensions\\'
5+
const outPath = "./dist/"
6+
7+
await esbuild.build({
8+
entryPoints: ["src/city_monitor.jsx"],
9+
bundle: true,
10+
outfile: outPath + 'city_monitor.transpiled.js',
11+
})

demo.mp4

12.6 MB
Binary file not shown.

0 commit comments

Comments
 (0)