Welcome to RedDwarf Server
RedDwarf Server is a horizontally scalable application server for low latency applications such as online games, virtual worlds, and social networking applications. It is a server side technology written in Java that radically simplifies the development of online games and lowers the barrier to entry into the MMOG market. RedDwarf is the official community fork for Project Darkstar, previously sponsored by Sun Microsystems, Inc.
Chapter 1: Starting Quickly
Introduction Interview An interview from the Project Darkstar days that gives a good introduction to a lot of the concepts behind Project Darkstar/RedDwarf.
Project Darkstar (RedDwarf) Architecture Slides from GDC-Austin 2007 attachment:darkstar-architecture.pdf
Server App Tutorial -- A detailed tutorial that will teach you how to build a basic application using RedDwarf. Please read this before posting questions in the forums.
Server API -- This describes the standard RedDwarf API that most RedDwarf application developers should use for the server side of their games.
Client API -- This is the client API that RedDwarf client applications should develop against to communicate with a RedDwarf server.
How to Get RedDwarf? -- Downloading RedDwarf or installing via Maven or building from source.
Maven plugin -- The RedDwarf Maven Plugin can be used to install, deploy, configure, and boot a RedDwarf server within the Maven life cycle.
Chapter 2: RedDwarf Overview
Documentation -- Documentation and useful resources (to be integrated/organized into these chapters).
Features? -- What RedDwarf can do right now.
Planned Features? -- New features coming to RedDwarf.
About RedDwarf? -- The history and goals of RedDwarf.
Chapter 3: Developing Applications
Setting Up Your IDE -- How to develop with your IDE (Eclipse and NetBeans covered).
Theory and Practice
Best Practices? -- Design theory and best practices.
Execution Model? -- Explanation of the unique execution model of RedDwarf that makes multi-threaded programming invisible.
Java Gotchas? -- Common Java practices that you should avoid and/or treat with care: statics, concurrency, serialization, synchronization, fail-safety.
Internal Server API -- Along with the external API, the internal API also exposes additional interfaces to RedDwarf developers that wish to write custom services, custom authenticators, custom protocols, or additional pluggable components in the RedDwarf framework. Using the internal API is for advanced use and is generally not encouraged unless necessary.
Writing Extensions -- Information on using the "extensions" feature to automatically register new functionality with RedDwarf.
Writing Services -- A grab of Seth Proctor's classic blog series on the subject.
Writing Protocols and Transports -- How to create transport and protocol plugins.
Custom Authentication -- Implementing custom authenticators.
Known Issues -- Known issues and workarounds.
Long Tasks -- Performing tasks that take too long to be processed in a single transaction.
Chapter 5: Administration and Configuration
Server VM Options -- How to modify the options used to start RedDwarf Server.
Server Properties -- The Javadoc page listing the configurable RedDwarf server properties.
Chapter 6: Libraries, Extensions, and Tools
Extensions -- Extensions and enhancements.
Client Implementations -- RedDwarf includes a BSD client API for both Java and C, but you may be interested in these community-supported APIs.
Chapter 7: Community Development
How to Start a Community Project? -- Found a problem that RedDwarf isn't solving out of the box? Start a project, and help the community! Here's how you can and what to expect when you do. iPhone development
Contribute Your Project? -- Contributing your existing project as a RedDwarf bundle.
Community Organization? -- How community projects are organized and maintained.
How to Use RedDwarf Bundle? -- How to use RedDwarf bundle, either single project or complete version.
Chapter 8: Core Development
Server Core API -- This javadoc describes all of the implementation classes that are part of the RedDwarf server. Using these classes should only be necessary if you wish to do core development on the RedDwarf code. Additionally, this suite of documentation contains the complete property configuration guide for the RedDwarf server.
Design Documents -- Design and discussion documents for server features.
Chapter 9: Bits and Bytes, Miscellany
Projects -- Projects using RedDwarf.
Appearance -- Suggestions for logos, layouts etc.
Using the Wiki
- TracGuide -- Built-in Documentation
- The Trac project -- Trac Open Source Project
- Trac FAQ -- Frequently Asked Questions
- TracSupport -- Trac Support
- TitleIndex -- A complete list of all wiki pages on this site