Skip to content

Latest commit

 

History

History
116 lines (78 loc) · 7.75 KB

README.md

File metadata and controls

116 lines (78 loc) · 7.75 KB

Intersect Engine

Intersect provides a complete game development suite for creating 2d mmorpgs with no programming experience or difficult setup steps required! Intersect is powered by MonoGame, and has been designed with stability and performance in mind. Intersect comes with custom assets that are free to use in your projects (even commercially) meaning that you can start developing your game in minutes!

Home https://freemmorpgmaker.com Docs https://docs.freemmorpgmaker.com main Visit us at https://ascensiongamedev.com Join the chat at https://discord.gg/Ggt3KJV

Automated Builds

We use GitHub 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.

Supported Platforms

Please refer to the Requirements document for support matrices.

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.

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!

Compiling/Development

Dependencies

Required

  • .NET 7 SDK, verified for v7.0.11 (SDK 7.0.401)
  • git: required for cloning submodules, if you want to do this manually you don't need this and use the .zip download but that is not supported
    • Tested on 2.42.0

Getting started

After cloning, run scripts/clone.sh for non-Windows systems, and scripts/clone.ps1 for Windows

  • On all platforms this clones any submodules via git submodule update --init --recursive
  • Via the .sh file it will also disable the Windows-only editor via git apply disable-windows-editor.patch

Compiling

To compile either use an IDE or one of the following commands:

  • dotnet build -p:Configuration=Debug -p:PackageVersion=0.8.0-beta -p:Version=0.8.0
    • Debug builds, all debug builds will not create single-file binary outputs
  • dotnet build -p:Configuration=Release -p:PackageVersion=0.8.0-beta -p:Version=0.8.0
    • Release builds will create single-file binary outputs but to get a clean output use dotnet publish
  • dotnet publish -p:Configuration=Release -p:PackageVersion=0.8.0-beta -p:Version=0.8.0 -r <runtime-id>
    • e.g. dotnet publish -p:Configuration=Release -p:PackageVersion=0.8.0-beta -p:Version=0.8.0 -r linux-x64
    • The automated builds use the above command for the RIDs linux-x64, osx-x64 and win-x64

Intersect Assets

Intersect is distributed with custom assets that have been curated from our community and around the net. Assets all match in style and are all safe to use freely in commercial projects.

Support and Contributions

If you think you have found a bug or have a feature request, use our issue tracker. Before opening a new issue, please search to see if your problem has already been reported. Try to be as detailed as possible in your issue reports.

If you need help using Intersect or have other questions we suggest you post on our community forums. Please do not use the GitHub issue tracker for personal support requests.

If you are interested in contributing fixes or features to Intersect, please read our contributors guide first.

Source Code

Getting started with Intersect couldn't be easier. Make sure you have Visual Studio 2019 Community installed.

  • Clone the source: git clone https://github.com/AscensionGameDev/Intersect-Engine.git
  • Open Intersect.sln
  • Restore Nuget packages
  • Build

We have documentation here tailored towards new developers that will guide you through installing visual studio, cloning the source, and getting started if you need more information.

Licensing

This project has split licensing. See license.md within each of the projects' folders.

Project License
Intersect.Core MIT license
Intersect.Client MIT license
Intersect.Client.Framework MIT license
Intersect.Network MIT license
Intersect.Editor GPLv3 license
Intersect.Server GPLv3 license
Intersect.Server.Framework GPLv3 license
Intersect.Utilities GPLv3 license

Third-party libraries used by Intersect are under their own licenses. Please refer to those libraries for details on the license they use.

Helpful Links