mirror of
https://github.com/TorqueGameEngines/Torque3D.git
synced 2026-07-16 09:04:38 +00:00
Fixed carousel, started work on PR guide, fixed all sorts of things.
This commit is contained in:
parent
7a1016aa85
commit
0352294fc3
4 changed files with 136 additions and 30 deletions
|
|
@ -29,9 +29,88 @@ root: ..
|
||||||
</div></div>
|
</div></div>
|
||||||
|
|
||||||
<div class="container">
|
<div class="container">
|
||||||
|
<h2>So you want to make a pull request</h2>
|
||||||
<p>
|
<p>
|
||||||
Code style guidelines, what we look for in a PR, links to git tutorials.
|
Pull requests are the way that community members like you can get your code
|
||||||
|
pulled into the official Torque 3D repository for everyone else to use. We
|
||||||
|
accept community contributions that align with our vision for the engine -
|
||||||
|
especially bug fixes, enhancements to existing features, and revisions of
|
||||||
|
old, slow, or ugly code. Pull requests are the way that code gets reviewed
|
||||||
|
before it's accepted into the engine - even cod that we, the Steering Committee,
|
||||||
|
write ourselves.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
In order to ensure the quality of the engine code going into the future, we
|
||||||
|
have strict rules about what code we can and cannot accept. We also have
|
||||||
|
some soft guidelines that inform our decision-making progress in trickier
|
||||||
|
cases.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<h2>Pull request rules</h2>
|
||||||
|
<p>
|
||||||
|
Pull requests not adhering to these rules <i>cannot</i> be accepted, so pay attention!
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>Obviously, your contribution cannot contain any code that is not
|
||||||
|
legally compatible with Torque 3D's MIT license. In addition, to legally
|
||||||
|
protect the engine and everyone affiliated with it, we require that all
|
||||||
|
contributors create an account on
|
||||||
|
<a href="http://garagegames.com">GarageGames.com</a> and sign the Open
|
||||||
|
Source Software Agreement there. For more information on the OSSA, please visit
|
||||||
|
<a href="https://github.com/GarageGames/Torque3D/wiki/Contributing#open-source-software-agreement">this page in our wiki</a>.</li>
|
||||||
|
|
||||||
|
<li>Contributions must adhere to our
|
||||||
|
<a href="https://github.com/GarageGames/Torque3D/wiki/Code-Style-Guidelines">code style guidelines</a>.</li>
|
||||||
|
|
||||||
|
<li>Pull-requests against the master branch cannot be accepted. All requests
|
||||||
|
must go to development, or an appropriate topic or maintenance branch.</li>
|
||||||
|
|
||||||
|
<li></li>
|
||||||
|
<li></li>
|
||||||
|
<li></li>
|
||||||
|
<li></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
In many cases, if any of these rules are breached, we will first ask the contributor
|
||||||
|
to resubmit their pull request, or add commits to it that resolve our issues.
|
||||||
|
In exceptional cases, a committee member may perform that work themselves.
|
||||||
|
Sometimes, we may also ask contributors to rebase large numbers of commits
|
||||||
|
into a single commit before the request is pulled.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<h2>Pull request guidelines</h2>
|
||||||
|
<p>
|
||||||
|
Here are some of the things we look for in a great pull request. These aren't
|
||||||
|
hard-and-fast rules, but following these guidelines will increase the chances
|
||||||
|
that your request is pulled!
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>Our favourite requests are ones that work directly towards the goals
|
||||||
|
laid out in our <a href="{{page.root}}/engine#roadmap">roadmap</a>. We
|
||||||
|
are more likely to help out and fix slightly broken pull requests if
|
||||||
|
they align with our goals, and chances are your request will move faster
|
||||||
|
through our process.</li>
|
||||||
|
|
||||||
|
<li>Each pull request should be <i>focused</i> and <i>concise</i>. If
|
||||||
|
it has a very clear intent and a small set of changes towards a specific
|
||||||
|
goal, it's easy for us to decide whether we want it, and to then test it
|
||||||
|
and make sure it works as advertised and doesn't break things.</li>
|
||||||
|
|
||||||
|
<li>If you're fixing a bug, we need you to provide steps to reproduce the
|
||||||
|
bug, so we can verify that exists and that your patch actually does fix it.
|
||||||
|
We'd also appreciate platform and compiler information.</li>
|
||||||
|
|
||||||
|
<li></li>
|
||||||
|
<li></li>
|
||||||
|
<li></li>
|
||||||
|
<li></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2>The pull request process</h2>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="banner"><div class="container">
|
<div class="banner"><div class="container">
|
||||||
|
|
|
||||||
10
css/main.css
10
css/main.css
|
|
@ -2,6 +2,10 @@
|
||||||
* Bootstrap overrides
|
* Bootstrap overrides
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
.container {
|
||||||
|
max-width: 760px;
|
||||||
|
}
|
||||||
|
|
||||||
.site .navbar-default {
|
.site .navbar-default {
|
||||||
background-color: white;
|
background-color: white;
|
||||||
}
|
}
|
||||||
|
|
@ -26,13 +30,17 @@
|
||||||
bottom: -40px;
|
bottom: -40px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.carousel-inner a {
|
||||||
|
color: white;
|
||||||
|
}
|
||||||
|
|
||||||
.site .carousel-indicators li {
|
.site .carousel-indicators li {
|
||||||
border-radius: 3px;
|
border-radius: 3px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.site .carousel-inner .item {
|
.site .carousel-inner .item {
|
||||||
width: 80%;
|
width: 80%;
|
||||||
margin: 0 auto;
|
margin-left: 10%;
|
||||||
}
|
}
|
||||||
|
|
||||||
.site h1 { font-size: 24px; }
|
.site h1 { font-size: 24px; }
|
||||||
|
|
|
||||||
|
|
@ -178,7 +178,7 @@ root: ..
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="media">
|
<div class="media">
|
||||||
<img class="pull-left feature" src="{{page.root}}/img/rendering-feature.jpg" />
|
<img class="pull-left feature" src="{{page.root}}/img/editors-feature.jpg" />
|
||||||
<div class="media-body">
|
<div class="media-body">
|
||||||
<h4 class="media-heading">Editors</h4>
|
<h4 class="media-heading">Editors</h4>
|
||||||
<p>
|
<p>
|
||||||
|
|
@ -240,7 +240,7 @@ root: ..
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="media">
|
<div class="media">
|
||||||
<img class="pull-left feature" src="{{page.root}}/img/rendering-feature.jpg" />
|
<img class="pull-left feature" src="{{page.root}}/img/scripting-feature.jpg" />
|
||||||
<div class="media-body">
|
<div class="media-body">
|
||||||
<h4 class="media-heading">Scripts and source code</h4>
|
<h4 class="media-heading">Scripts and source code</h4>
|
||||||
<p>
|
<p>
|
||||||
|
|
@ -252,8 +252,15 @@ root: ..
|
||||||
<p>
|
<p>
|
||||||
If you're not the recompiling type, Torque provides a scripting engine
|
If you're not the recompiling type, Torque provides a scripting engine
|
||||||
using a custom C-like language called TorqueScript. You can create
|
using a custom C-like language called TorqueScript. You can create
|
||||||
whole games without touching a line of C++.
|
whole games without touching a line of C++. Check this out:
|
||||||
</p>
|
</p>
|
||||||
|
<pre><code>$minion = new AIPlayer();
|
||||||
|
$minion.name = "Fubar";
|
||||||
|
$minion.setMoveDestination("50 0 0");
|
||||||
|
|
||||||
|
function Fubar::onReachDestination(%self) {
|
||||||
|
echo("I made it! Says" SPC %self.name);
|
||||||
|
}</code></pre>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
@ -263,12 +270,13 @@ root: ..
|
||||||
</div></div>
|
</div></div>
|
||||||
|
|
||||||
<div class="container">
|
<div class="container">
|
||||||
<p>
|
<p class="alert alert-warning">
|
||||||
Please note that the roadmap is currently being debated by the Steering Committee.
|
Please note that the roadmap is currently being debated by the Steering Committee.
|
||||||
This version represents our rough ideas and intentions and may change when we
|
This version represents our rough ideas and intentions and may change when we
|
||||||
settle on an actual plan! When that happens we will document future engine
|
settle on an actual plan! When that happens we will document future engine
|
||||||
versions here with their planned outcomes.
|
versions here with their planned outcomes.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h2>Short-term</h2>
|
<h2>Short-term</h2>
|
||||||
<p>
|
<p>
|
||||||
The theme of our immediate efforts will be cleaning up the state of the repository,
|
The theme of our immediate efforts will be cleaning up the state of the repository,
|
||||||
|
|
@ -280,12 +288,14 @@ root: ..
|
||||||
<li>Set up automated testing to increase confidence in pull requests.</li>
|
<li>Set up automated testing to increase confidence in pull requests.</li>
|
||||||
<li>Merge (possibly into unstable branches) or reject all outstanding pull-requests.</li>
|
<li>Merge (possibly into unstable branches) or reject all outstanding pull-requests.</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2>Middle-term</h2>
|
<h2>Middle-term</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Linux and OSX support via OpenGL rendering layer.</li>
|
<li>Linux and OSX support via OpenGL rendering layer.</li>
|
||||||
<li>Clean up engine source code (e.g. use of non-STL container replacements, signed/unsigned mismatches).</li>
|
<li>Clean up engine source code (e.g. use of non-STL container replacements, signed/unsigned mismatches).</li>
|
||||||
<li>New modular script templates and content distribution.</li>
|
<li>New modular script templates and content distribution.</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h2>Long-term</h2>
|
<h2>Long-term</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li>Modularise scripting engine, paving the way for other scripting languages.</li>
|
<li>Modularise scripting engine, paving the way for other scripting languages.</li>
|
||||||
|
|
@ -315,7 +325,7 @@ root: ..
|
||||||
<p>
|
<p>
|
||||||
GarageGames sold TGE for around $100USD throughout the product's lifetime,
|
GarageGames sold TGE for around $100USD throughout the product's lifetime,
|
||||||
increasing this to $150 with the release of TGE 1.5. Its selling point against
|
increasing this to $150 with the release of TGE 1.5. Its selling point against
|
||||||
other engines was its strong networking (that had powered 128-player games
|
other engines was its strong networking (which had powered 128-player games
|
||||||
of Tribes 2), its terrain rendering, and the fact that a license bought you
|
of Tribes 2), its terrain rendering, and the fact that a license bought you
|
||||||
the entire engine source code. During this time, GarageGames spun off numerous
|
the entire engine source code. During this time, GarageGames spun off numerous
|
||||||
other products - TorqueX focused on delivering the same strengths to the XNA
|
other products - TorqueX focused on delivering the same strengths to the XNA
|
||||||
|
|
|
||||||
47
index.html
47
index.html
|
|
@ -5,12 +5,13 @@ root: .
|
||||||
---
|
---
|
||||||
|
|
||||||
<div class="jumbotron banner">
|
<div class="jumbotron banner">
|
||||||
<div id="home-carousel" class="carousel slide" data-ride="carousel" data-interval="false">
|
<div id="home-carousel" class="carousel slide" data-ride="carousel">
|
||||||
<!-- Indicators -->
|
<!-- Indicators -->
|
||||||
<ol class="carousel-indicators">
|
<ol class="carousel-indicators">
|
||||||
<li data-target="#home-carousel" data-slide-to="0" class="active"></li>
|
<li data-target="#home-carousel" data-slide-to="0" class="active"></li>
|
||||||
<li data-target="#home-carousel" data-slide-to="1"></li>
|
<li data-target="#home-carousel" data-slide-to="1"></li>
|
||||||
<li data-target="#home-carousel" data-slide-to="2"></li>
|
<li data-target="#home-carousel" data-slide-to="2"></li>
|
||||||
|
<li data-target="#home-carousel" data-slide-to="3"></li>
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
<!-- Wrapper for slides -->
|
<!-- Wrapper for slides -->
|
||||||
|
|
@ -23,7 +24,7 @@ root: .
|
||||||
<img src="{{page.root}}/img/torque.png"></img>
|
<img src="{{page.root}}/img/torque.png"></img>
|
||||||
</div>
|
</div>
|
||||||
<div class="col-sm-8">
|
<div class="col-sm-8">
|
||||||
<h1 class="title">{{site.name}}</h1>
|
<h1 class="title">Torque 3D</h1>
|
||||||
<p>The open-source game engine of the future.</p>
|
<p>The open-source game engine of the future.</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
@ -37,8 +38,11 @@ root: .
|
||||||
<img src="{{page.root}}/img/torque.png"></img>
|
<img src="{{page.root}}/img/torque.png"></img>
|
||||||
</div>
|
</div>
|
||||||
<div class="col-sm-8">
|
<div class="col-sm-8">
|
||||||
<h1 class="title">{{site.name}}</h1>
|
<h1 class="title">Gratis et libre</h1>
|
||||||
<p>The open-source game engine of the future.</p>
|
<p>Torque 3D is free as in speech <i>and</i> free as
|
||||||
|
in beer. Under the permissive MIT license, you can
|
||||||
|
do what you want with the source code!</p>
|
||||||
|
<a href="{{page.root}}/start" class="pull-right">Download it now <i class="fa fa-angle-double-right"></i></a>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
@ -51,8 +55,26 @@ root: .
|
||||||
<img src="{{page.root}}/img/torque.png"></img>
|
<img src="{{page.root}}/img/torque.png"></img>
|
||||||
</div>
|
</div>
|
||||||
<div class="col-sm-8">
|
<div class="col-sm-8">
|
||||||
<h1 class="title">{{site.name}}</h1>
|
<h1 class="title">Feature rich</h1>
|
||||||
<p>The open-source game engine of the future.</p>
|
<p>Packed with features and easy-to-use editors, T3D
|
||||||
|
has you covered even if you have no programming experience.</p>
|
||||||
|
<a href="{{page.root}}/engine" class="pull-right">Read the feature list <i class="fa fa-angle-double-right"></i></a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="item">
|
||||||
|
<div class="container">
|
||||||
|
<div class="row">
|
||||||
|
<div class="col-sm-4">
|
||||||
|
<img src="{{page.root}}/img/torque.png"></img>
|
||||||
|
</div>
|
||||||
|
<div class="col-sm-8">
|
||||||
|
<h1 class="title">Always evolving</h1>
|
||||||
|
<p>Torque 3D is being actively developed by an
|
||||||
|
enthusiastic community. Can you help out?</p>
|
||||||
|
<a href="{{page.root}}/contribute" class="pull-right">Get involved <i class="fa fa-angle-double-right"></i></a>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
@ -72,25 +94,12 @@ root: .
|
||||||
<div class="container">
|
<div class="container">
|
||||||
<div class="row">
|
<div class="row">
|
||||||
<div class="col-sm-4">
|
<div class="col-sm-4">
|
||||||
<h2>Gratis et libre</h2>
|
|
||||||
<p>Torque 3D is free as in speech <i>and</i> free as in beer. Under
|
|
||||||
the permissive MIT license, you can do what you want with the source
|
|
||||||
code!</p>
|
|
||||||
<a href="{{page.root}}/start" class="pull-right">Download it now <i class="fa fa-angle-double-right"></i></a>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="col-sm-4">
|
<div class="col-sm-4">
|
||||||
<h2>Feature rich</h2>
|
|
||||||
<p>Packed with features and easy-to-use editors, T3D has you covered
|
|
||||||
even if you have no programming experience.</p>
|
|
||||||
<a href="{{page.root}}/engine" class="pull-right">Read the feature list <i class="fa fa-angle-double-right"></i></a>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="col-sm-4">
|
<div class="col-sm-4">
|
||||||
<h2>Always evolving</h2>
|
|
||||||
<p>Torque 3D is being actively developed by an enthusiastic community.
|
|
||||||
Can you help out?</p>
|
|
||||||
<a href="{{page.root}}/contribute" class="pull-right">Get involved <i class="fa fa-angle-double-right"></i></a>
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue