Getting Started

25 Febuary 2018, 04:47 GMT

Welcome to the Official Qub3d Getting Started Guide!

This file is dedicated to getting started in general with the Qub3d Engine Group.

The simplest way to get started with Qub3d is to join the official Discord Server. We also have an official IRC channel on freenode: #qub3d. If you have any issues that just don’t quite fit inside Discord or IRC, don’t fret! We have an official email address: y​o​@​q​u​b​3​d​.​o​r​g where you can send questions that don’t contain spam/inappropriate/irrelevant content. This email is only used for questions regarding the Qub3d Engine Group.

There are other guides/howtos that go beyond this guide in some fields, such as the Contributors’ Guide and the Documentation Howto. This guide is just to help you get ready for getting our hands dirty with the Qub3d repositories.

The aim of this guide is to familiarize new users to the Qub3d Engine Group and its tools. In this guide, we give a brief introduction on each tool used in the Qub3d project, and the Qub3d Engine Group and all of its participating members. If you appreciate this project enough to contribute, then please read the Contributors’ Guide.

Qub3d Engine Group

The team is made up of volunteer developers. They are:

TMcSquared (Thomas Monroe/Tre): Lead Code Wrangler

NewbProgrammer101 (Jalus Bilieyich/Jay): Repository Sentry

SonosFuer (apachano/Austin): Docs Librarian

toby109tt (Toby): Lead Artist

TheScarecröwman (Anonymous): The Leader’s Leader

THE ABOVE LIST WILL BE FIXED LATER

TMcSquared

To be filled in later.

NewbProgrammer101

To be filled in later.

SonosFuer

To be filled in later.

toby109tt

To be filled in later.

TheScarecröwman

To be filled in later.

Exploring Phabricator

The applications listed below are found at the left of the Phabricator home page in chronological order.

  • Home: The home page of our Phabricator.
  • Task Finder [P]: Find a programming task to work on.
  • Getting Started: Instructions to get started.
  • Dev Docs: Where the documentation targeted at developers and contributors is located.
  • Feed: This is where the liveliness of Qub3d is shown.
  • Flags: Where all your personal bookmarks within Phabricator are found.

Planning

  • Tasks: Task and bug tracker. Similar to GitHub Issues. Also called Maniphest.
  • Wiki: Official, collaborative, and online Wiki dedicated to the Qub3d project.
  • Projects: Browse projects, groups, and other tags. Projects also have Workboards, similar to GitHub Projects.
  • Design Review: Review design, mocks, etc.

Code

  • Code Review: Submit and review code (pre-commit review). Similar to GitHub Pull Requests.
  • Repositories: The source of the Qub3d Engine Group’s works.
  • Audit: Post-commit review. Raise concerns about code that’s already been committed.

Tools

  • Calendar: Planned events billboard.
  • Etherpad: Collaborative and real-time live editing of files.
  • Paste: Pastebin with syntax highlighting, history, and comments. Similar to GitHub Gist.
  • Phurl: URL shortener. Similar to bit.ly and goo.gl.
  • Ponder: Q&A, StackOverflow style.
  • Slowvote: Development polls where everyone can vote and comment on.

Setup Instructions

GNU/Linux

Windows

Mac OS X