Clojure C# Other
Clone or download
nasser Merge pull request #279 from green-coder/contributor-agreement
Arcadia Contributor License Agreement
Latest commit af3520d May 2, 2018
Permalink
Failed to load latest commit information.
Components catch up with 2018.1b Mar 8, 2018
Editor Address issue #259 Nov 4, 2017
Helpers Mild refactoring for HookStateSystem Dec 28, 2017
Infrastructure Load certs from file instead of web Aug 24, 2017
Source Merge pull request #272 from pjago/develop Apr 25, 2018
.gitignore adding TimeSnap Sep 21, 2017
CONTRIBUTOR-LICENSE-AGREEMENT.md Add Arcadia's name to CONTRIBUTOR-LICENSE-AGREEMENT Feb 12, 2017
CONTRIBUTOR-LICENSE-AGREEMENT.md.meta binds *compiler-options* to arcadia.config's :compiler/options key Mar 24, 2017
CONTRIBUTORS.md I have read and agree to the terms of the Arcadia Contributor License… Apr 28, 2018
CONTRIBUTORS.md.meta binds *compiler-options* to arcadia.config's :compiler/options key Mar 24, 2017
Compiled.meta binds *compiler-options* to arcadia.config's :compiler/options key Mar 24, 2017
Components.meta Revert "rm and gitignore .meta files" Feb 12, 2017
Editor.meta Revert "rm and gitignore .meta files" Feb 12, 2017
Helpers.meta Revert "rm and gitignore .meta files" Feb 12, 2017
Infrastructure.meta Revert "rm and gitignore .meta files" Feb 12, 2017
Plugins.meta Revert "rm and gitignore .meta files" Feb 12, 2017
README.md removed empty line from readme.md Aug 21, 2017
README.md.meta Revert "rm and gitignore .meta files" Feb 12, 2017
Source.meta Revert "rm and gitignore .meta files" Feb 12, 2017
USAGE.md Update Unity versioni in USAGE May 2, 2018
USAGE.md.meta Revert "rm and gitignore .meta files" Feb 12, 2017
configuration.edn nudge on by default Nov 16, 2017
configuration.edn.meta Revert "rm and gitignore .meta files" Feb 12, 2017

README.md

Arcadia

The integration of the Clojure Programming Language with the Unity 3D game engine.

Status

Arcadia is alpha-quality software, and shouldn't be used for anything important yet.

Community

Installing

The contents of the repository should be copied to a folder named Arcadia in any Unity project's Assets folder to enable Clojure. In the future, this will be available from the Asset Store. Once copied, you have access to the REPL and the Clojure compiler.

Download Zip File

  1. Create a subfolder of your Assets folder named Arcadia
  2. Download our zip file and extract its contents into Arcadia

Git Clone

cd path/to/unity/project/Assets
git clone https://github.com/arcadia-unity/Arcadia.git

Usage

USAGE.md us a good place to start, as is the Wiki. They both cover how to get started and all the prerequisites you'll need. The community on the Gitter is very helpful and happy to answer questions.

REPL

Arcadia ships with a simple networked REPL that is started automatically or from Clojure > REPL > Start. To integrate your text editor with Arcadia, there are a few clients listed on the Wiki. Additionally, there are three command line scripts that act as REPL clients if that makes your integration easier. Editor/repl-client.rb, Editor/repl-client.javascript, and Infrastructure/repl. Infrastructure/repl is the future, but not totally stable yet. You should try them all and use what works best.

The core devs use the REPL from Emacs (via Inferior Lisp) and SublimeText (via Socket).

Contributing

If you're thinking of submitting code to Arcadia – thanks! We're excited to have your help. First, all contributors must read and agree to our contributor license agreement. It is based on GitHub's CLA and ensures that the code you submit remains useable by Arcadia and its community without issue. It confirms that

  1. Anyone can use your contributions anywhere, for free, forever.
  2. Your contributions do not infringe on anyone else's rights.
  3. You retain ownership of your contribution.

Once you have read and agree to it, submit a Pull Request adding your name and GitHub id to CONTRIBUTORS.md with the following commit message:

I have read and agree to the terms of the Arcadia Contributor License Agreement.

You only need to do this once. After that, we can review and merge any contributions you send us!

Name

This project was originally named "clojure-unity", but was changed to "Arcadia" to avoid infinging on Clojure's trademarks. It was suggested to us by @ztellman at a bar during StrangeLoop 2014, and we are eternally grateful.

Legal

Copyright © 2014-2017 Tims Gardner, Ramsey Nasser, and contributors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.