Skip to content

Commit 23ef475

Browse files
committed
drop LNL patch, update build scripts, update docs
update forum poster add RIDs
1 parent ea04953 commit 23ef475

File tree

8 files changed

+108
-307
lines changed

8 files changed

+108
-307
lines changed

.github/workflows/build.0.7.2-beta.yml

Lines changed: 0 additions & 139 deletions
This file was deleted.
Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
name: Build Intersect (.NET 7.0)
1+
name: Intersect (main)
22

33
on:
44
push:
5-
branches: [ "main-net7", "main-net7-proto" ]
6-
pull_request:
7-
branches: [ "main-net7" ]
5+
branches: [ "main" ]
6+
paths-ignore:
7+
- '.github/**'
88
workflow_dispatch:
99
inputs:
1010
workflowDebug:
@@ -71,11 +71,6 @@ jobs:
7171
- name: Build solution
7272
if: steps.cache-binaries.outputs.cache-hit != 'true' || inputs.forceBuild == true || inputs.forceRestore == true
7373
run: |
74-
cd vendor/LiteNetLib
75-
cat LiteNetLib/LiteNetLib.csproj
76-
git apply --whitespace=fix ../LiteNetLib.patch
77-
cat LiteNetLib/LiteNetLib.csproj
78-
cd ../..
7974
dotnet publish Intersect.sln -r win-x64 -p:Configuration=Release -p:PackageVersion=${{ env.VERSION_PREFIX }}${{ env.VERSION_SUFFIX }}.${{ github.run_number }}+build.${{ github.sha }} -p:Version=${{ env.VERSION_PREFIX }}.${{ github.run_number }}
8075
git apply disable-windows-editor.patch
8176
dotnet publish Intersect.sln -r linux-x64 -p:Configuration=Release -p:PackageVersion=${{ env.VERSION_PREFIX }}${{ env.VERSION_SUFFIX }}.${{ github.run_number }}+build.${{ github.sha }} -p:Version=${{ env.VERSION_PREFIX }}.${{ github.run_number }}
@@ -125,3 +120,18 @@ jobs:
125120
name: ${{ env.VERSION_PREFIX }}${{ env.VERSION_SUFFIX }}.${{ github.run_number }}
126121
prerelease: true
127122
tag: v${{ env.VERSION_PREFIX }}${{ env.VERSION_SUFFIX }}.${{ github.run_number }}
123+
124+
publish:
125+
if: inputs.workflowDebug != true
126+
needs: build
127+
runs-on: ubuntu-latest
128+
steps:
129+
- name: Publish to Forum
130+
uses: AscensionGameDev/actions@0223df40becb110039c705c02cfd2cd8f274199c
131+
with:
132+
api-key: ${{ secrets.INTERSECTBOT_FORUM_TOKEN }}
133+
build: ${{ github.run_number }}
134+
hash: ${{ github.sha }}
135+
runtime-identifiers: linux-x64,osx-x64,win-x64
136+
topic-id: ${{ vars.INTERSECTBOT_FORUM_TOPIC_ID }}
137+
version: ${{ env.VERSION_PREFIX }}${{ env.VERSION_SUFFIX }}

README.md

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,19 @@ Intersect provides a complete game development suite for creating 2d mmorpgs wit
44

55
[![Home https://freemmorpgmaker.com](https://img.shields.io/badge/Home-Free%20MMORPG%20Maker-informational)](https://freemmorpgmaker.com)
66
[![Docs https://docs.freemmorpgmaker.com](https://img.shields.io/badge/Docs-Online-success)](https://docs.freemmorpgmaker.com)
7-
[![v0.7.2-beta](https://github.com/AscensionGameDev/Intersect-Engine/actions/workflows/build.0.7.2-beta.yml/badge.svg?branch=main)](https://github.com/AscensionGameDev/Intersect-Engine/actions/workflows/build.0.7.2-beta.yml)
7+
[![main](https://github.com/AscensionGameDev/Intersect-Engine/actions/workflows/build.yml/badge.svg)](https://github.com/AscensionGameDev/Intersect-Engine/actions/workflows/build.yml)
88
[![Visit us at https://ascensiongamedev.com](https://img.shields.io/badge/Community-Ascension%20Game%20Dev-orange)](https://ascensiongamedev.com)
99
[![Join the chat at https://discord.gg/Ggt3KJV](https://img.shields.io/discord/363106200243535872?color=%237289DA&label=Discord&logoColor=white)](https://discord.gg/Ggt3KJV)
1010

1111
- [Intersect Engine](#intersect-engine)
1212
- [Automated Builds](#automated-builds)
1313
- [Supported Platforms](#supported-platforms)
14+
- [Compiling/Development](#compilingdevelopment)
15+
- [Dependencies](#dependencies)
16+
- [Required](#required)
17+
- [Optional (strongly recommended)](#optional-strongly-recommended)
18+
- [Getting started](#getting-started)
19+
- [Compiling](#compiling)
1420
- [Intersect Assets](#intersect-assets)
1521
- [Support and Contributions](#support-and-contributions)
1622
- [Source Code](#source-code)
@@ -22,22 +28,43 @@ Intersect provides a complete game development suite for creating 2d mmorpgs wit
2228

2329
We use [GitHub Actions](https://github.com/AscensionGameDev/Intersect-Engine/actions) for building and packaging the latest updates for the engine. Releases with downloadable bundles can be found on the [Releases page on our GitHub repository](https://github.com/AscensionGameDev/Intersect-Engine/releases).
2430

25-
| Name | Status |
26-
| :--- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
27-
| main | [![Build Status](https://teamcity.freemmorpgmaker.com/app/rest/builds/buildType:main/statusIcon)](https://teamcity.freemmorpgmaker.com/viewType.html?buildTypeId=main&guest=1) |
28-
29-
3031
## Supported Platforms
3132

32-
* Desktop PCs (Open GL)
33-
* Windows
34-
* Mac OS X
35-
* Linux
33+
Please refer to the [Requirements](./REQUIREMENTS.md) document for support matrices.
3634

3735
Our editor uses DirectX and must be ran in Windows, but you can host and play your game on any desktop os that supports OpenGL.
3836

3937
We're open to expanding to new platforms (mobile, web, etc) but don't have the capacity to do so at this time. If you're interested in helping out let us know!
4038

39+
## Compiling/Development
40+
41+
### Dependencies
42+
43+
#### Required
44+
45+
- [.NET 7 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/7.0), verified for v7.0.11 (SDK 7.0.401)
46+
47+
#### Optional (strongly recommended)
48+
49+
- git: required for cloning submodules, if you want to do this manually this is not needed
50+
- Tested on 2.42.0
51+
52+
### Getting started
53+
54+
After cloning, run `scripts/clone.sh` for non-Windows systems, and `scripts/clone.ps1` for Windows
55+
- On all platforms this clones any submodules via `git submodule update --init --recursive`
56+
- Via the .sh file it will also disable the Windows-only editor via `git apply disable-windows-editor.patch`
57+
58+
### Compiling
59+
60+
To compile either use an IDE or one of the following commands:
61+
- `dotnet build -p:Configuration=Debug -p:PackageVersion=0.8.0-beta -p:Version=0.8.0`
62+
- Debug builds, all debug builds will _not_ create single-file binary outputs
63+
- `dotnet build -p:Configuration=Release -p:PackageVersion=0.8.0-beta -p:Version=0.8.0`
64+
- Release builds will create single-file binary outputs but to get a clean output use `dotnet publish`
65+
- `dotnet publish -p:Configuration=Release -p:PackageVersion=0.8.0-beta -p:Version=0.8.0 -r <runtime-id>`
66+
- e.g. `dotnet publish -p:Configuration=Release -p:PackageVersion=0.8.0-beta -p:Version=0.8.0 -r linux-x64`
67+
- The automated builds use the above command for the RIDs `linux-x64`, `osx-x64` and `win-x64`
4168

4269
## Intersect Assets
4370

REQUIREMENTS.md

Lines changed: 45 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,61 @@
11
# Requirements
22

3-
## Support Matrix
3+
## Dependencies
44

5-
-------------------------------------------------------------------------------
6-
| OS | Status | Official |
7-
-------------------|-----------------------------------------------|-----------
8-
| Windows 8.1 | [⚠️](#windows-81 "Requires updates") | 🚫 |
9-
| Windows 10 | [⚠️](#windows-10 "May require updates") ||
10-
| Windows 11 | [⚠️](#windows-11 "May require updates") ||
11-
| MacOS 13 Ventura | [⚠️](#macos-13-ventura "May require updates") ||
12-
| Manjaro | [](#manjaro "May require updates") ||
13-
| Android | 🚫 Not Yet Supported | |
14-
| iOS | 🚫 Not Yet Supported | |
15-
-------------------------------------------------------------------------------
5+
If you are unable to run the engine, please make sure to download the [.NET 7 Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/7.0).
166

17-
## Windows
7+
## Support Matrix
188

19-
### Windows 8.1
9+
--------------------------------------------------------------------------------------------
10+
| OS | Official | Status | Notes |
11+
----------------------|----------|--------|-------------------------------------------------
12+
| Android | | | 🚫 Not Yet Supported |
13+
| iOS | | | 🚫 Not Yet Supported |
14+
| [Linux](#linux) ||| ARM64 not currently supported |
15+
| [MacOS](#macos) ||| ARM64 only supported via [Rosetta][rosetta] |
16+
| [Windows](#windows) ||| Only 10+ on x64 supported, but others may work |
17+
--------------------------------------------------------------------------------------------
2018

21-
- [KB3118401](https://www.microsoft.com/en-us/download/details.aspx?id=51109)
19+
## Linux
2220

23-
### Windows 10
21+
### Tested Distros
2422

25-
_Not tested on a clean install_
23+
----------------------------------------------------------------------------------------
24+
| Distro | Kernel | Status | Notes |
25+
----------------------|--------------------|--------|----------------------------------|
26+
| Manjaro | 5.15.133-1-MANJARO || Only tested on dev machine |
27+
----------------------------------------------------------------------------------------
2628

27-
### Windows 11
29+
## MacOS
2830

29-
_Not tested on a clean install_
31+
> Note: Launching the Client/Server from Finder via clicking appears to launch it from `$HOME`.
32+
>
33+
> You need to launch them from the command line or via a wrapper (not included).
3034
31-
## MacOS
35+
-------------------------------------------------------------------------------
36+
| Version | Official | Status |
37+
-------------------|----------|------------------------------------------------
38+
| 11.7 Big Sur | 🚫 | [⚠️](#macos "Untested") |
39+
| 12.7 Monterey | 🚫 | [⚠️](#macos "Untested") |
40+
| 13.6 Ventura || [*](#macos "Only tested on dev machine") |
41+
| 14.0 Sonoma || [*](#macos "Untested") |
42+
-------------------------------------------------------------------------------
3243

33-
### MacOS 13 "Ventura"
44+
## Windows
3445

35-
_Not tested on a clean install_
46+
-------------------------------------------------------------------------------
47+
| Version | Official | Status |
48+
-------------------|----------|------------------------------------------------
49+
| Windows 7 | 🚫 | [](#windows "End-of-Life 2020-01-14") |
50+
| Windows 8 | 🚫 | [](#windows "End-of-Life 2016-01-12") |
51+
| Windows 8.1 | 🚫 | [⚠️](#windows-81 "End-of-Life 2023-07-11") |
52+
| Windows 9 | 🪦 | [🪦](#windows "They skipped it") |
53+
| Windows 10 |||
54+
| Windows 11 |||
55+
-------------------------------------------------------------------------------
3656

37-
## Linux
57+
### Windows 8.1
3858

39-
### Manjaro
59+
- [KB3118401](https://www.microsoft.com/en-us/download/details.aspx?id=51109)
4060

41-
_Not tested on a clean install_
61+
[rosetta]: https://support.apple.com/en-us/HT211861

scripts/clone.ps1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
git submodule update --init --recursive

scripts/clone.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/usr/bin/env bash
2+
3+
git submodule update --init --recursive
4+
5+
git apply disable-windows-editor.patch

vendor/LiteNetLib

0 commit comments

Comments
 (0)