Aurora-Sim/GettingStarted

De DigiWiki.

SPECIAL NOTICE: Astra Viewer "Draft" sections added into Sidebar. Links to initial draft pages which are still being written. -07:09, 16 September 2011 (EDT) The Aurora-Sim wiki is being revised and restructured over the next couple of weeks. Thank you in advance for your patience while we improve our wiki. Go back to the main website[1].

Getting started

Aurora-Sim is a free virtual world software aimed for compatibility with many types of virtual world clients. Based of the OpenSimulator project, we support the Second Life® client and our main goal is to provide a feature-rich world, along with stability and scalability. This focus on stability and scalability allows you to use Aurora-Sim to run large scale operations and extend it as needed, while still having many features available to use.

Our architecture is designed to be as flexible as possible, so that third parties can connect into our modular design and utilize Aurora-Sim as much as possible. We are cross-platform compatible by using .NET and Mono and can be run on many platforms.

Please keep in mind that the Aurora-Sim platform is still in alpha and so may not always perform as expected.

Getting Involved as a tester

A most critical function! We always need testers to help us find bugs and quirks. There are no special requirements, other than a willingness to help, live with bugs till it's fixed and reporting things as they happen or change... All Platforms/Operating Systems testing is needed. How you want to do the testing is up to you: running it on your own computer or on a shared / dedicated server in a data center, used in Standalone or as a grid attached region.

Every variety & method needs solid testing.

If you test it would be most helpful to look in our MANTIS bug tracker [2] to see if the bug you have experienced has already been reported. If it has, please add a comment so we know the scope of the bug, and otherwise report it so that we can look into the issue.

Please follow our Mantis etiquette guidelines when filing or adding to Mantis issues (available here [3])

You will need to make an account for our MANTIS bug tracker to create or edit issues.

Getting Involved as a Developer

Getting the code

GIT Master Source Code Git Repository Source

• Requires using Git Software to pull, compile and run.
• Extra modules should be added prior to compile.

ZIP Master Source Code Zip Source

• This is raw source code and does not require the use of Git Software(s).
• Extra modules should be added prior to compile.

---

We use the source control 'git' for our project[4] and our code is hosted at github.com. The source code is publicly accessible as follows:

Aurora Available Downloads github

Aurora-Sim LINK

Aurora-Sim-Optional-Modules LINK

Aurora-WebUI LINK

Whisper-Server (Voice) LINK

StarDust (Currency) LINK

We strongly recommend creating an account on github and forking our project if you intend to make changes, as this will make it easier for both you and the project to merge in your changes should you wish. This allows us to easily add your commits to our project and keep the committer information available for others to see. Please also read the "Submitting patches" section on this page for more information about submitting patches to Aurora-Sim.

Code Documentation and how to get started developing

Most of the developer information can be found on our wiki here[5] and here[6]

but we will cover the general topics here.
Code Documentation: here[7]
Code Submission Policy: here[8]
Code Standards: here[9]
Get started with the basics (IRegionModuleBase, INonSharedRegionModule, ISharedRegionModule): here[10]
Get started with the basics (ISharedRegionStartupModule modules): here[11]
Get started with the basics (IService modules (Aurora.Server service)): here[12]
Get started with the basics (IApplicationPlugin modules (application module)): here[13]
Understanding the code flow of Aurora: here[14]
How Aurora works (internally): here[15]

Submitting bug reports/feature requests

We have a bug tracker that is used for submitting bug reports and feature requests (powered by MANTIS), which is available here[16]. Any valid bug reports are welcome, but please follow our bug tracker etiquette, available here[17].

Submitting patches

Anyone can make changes to the source code and do their own tests. Tested patches are always appreciated and if they pass can & likely will be applied fairly quickly.

Developers who wish to be be active contributors are most welcome and appreciated. Previous experience with OpenSimulator would make it easier to step in and previous C# / .Net programming experience is certainly a big plus.

There are a couple of simple rules that people contributing any code to the Aurora-Sim project need to follow and it is important to meet the licensing criteria. Please read this page[18] if you would like to contribute code.