Skip to content
Documentation about using Unity (c#) with Haxe
Haxe HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
00setup
01helloworld
02trace
02trace2
03writing
04reading
05haxelow
06keep
08json
09build
10json
docs
haxe
haxecs
img
resources
.gitignore
LICENSE
README.md
README_old.md
SUMMARY.md
TODO.md
book.json
build.hxml
contribute.md
icon.png
intro.md
package-lock.json
package.json

README.md

Haxe and Unity (C#)

With most of the documentation I wrote, it was something that I needed. Because this type of documentation is valuable only when you have no idea how to start. It's the basic stuff that I run into when I start with a new Haxe target.

I would suggest you would visit Haxe and System Targets as well because it covers the system targets and C# is that as well.

This documentation is focussed on Unity and Haxe and specifics to get it working in with Unity.

Visit http://matthijskamstra.github.io/haxeunity/

How to contribute?

Read more about that here. But it boils down to: JUST DO IT!

Visit https://github.com/MatthijsKamstra/haxeunity to modify the "source" aka markdown files.

Found any "bug" or have a great idea? Please create a new issue.

How to build?

I will be using Gitbook to export to static html. You need to install Node.js and then you automatically have NPM:

Install gitbook

npm install gitbook-cli -g

or if you have gitbook installed, update it

gitbook update

I wanted to make the editing of these file as-easy-as-possible. This gitbook plugin helps with that: gitbook plugin edit link. And if all fails, I used Disqus comments on your books to add comments at the bottom of each page.

Activate the plugins with:

gitbook install

Export everything to html

gitbook build

NPM build

I created a little script with NPM to make my life somewhat easier:

npm run gitbook

Will install and update gitbook

npm run build

Will remove old docs- and _book-folder, build new gitbook and rename _book- to docs-folder.

npm run deploy

Will just push everything without consideration

What is Gitbook?

Gitbook logo

I will be using gitbook to generate the website.

Primarily reason for this: I have never used it, it uses markdown as input files and it also generates a static html site.

What is Markdown

Markdown logo A familiar way to write documentation for developers. This should make it easier to contribute!

Markdown is a plain text formatting syntax created by John Gruber, aiming to provide a easy-to-read and feasible markup. You can find the original Markdown syntax specification here.

MacDown logo MacDown is a simple-to-use editor for Markdown documents. It renders your Markdown contents real-time into HTML, and display them in a preview panel. You can download it here.

You can’t perform that action at this time.