Skip to content

Commit

Permalink
doc lnk Tasks.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cryham committed Feb 9, 2025
1 parent de2203f commit 3e6d739
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 33 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ assignees: ''

** General Info **
Please be aware that it may be already posted, known, planned, discussed etc.
Useful docs pages to check first: [Roadmap](https://github.com/stuntrally/stuntrally3/blob/main/docs/Roadmap.md), To Do [Tasks](https://stuntrally.tuxfamily.org/mantis/view_all_bug_page.php).
Useful docs pages to check first: [Roadmap](https://github.com/stuntrally/stuntrally3/blob/main/docs/Roadmap.md), To Do [Tasks](https://github.com/stuntrally/stuntrally3/blob/main/docs/Tasks.md).

**Describe the solution you'd like**
A clear description of what you want to happen, or any alternative solutions or features you've considered.
Expand Down
9 changes: 4 additions & 5 deletions docs/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Help is welcomed.
Thank you for all your contributions.

Even smaller things count like:
- 👥Increasing popularity, spreading info about Stunt Rally 3 on internet (with link to our [website](https://stuntrally.tuxfamily.org/)).
- 👥Increasing popularity, spreading info about Stunt Rally 3 on internet (with link to SR [website](https://cryham.org/stuntrally/)).
- 🪲Testing and reporting bugs ([Issues on github](https://github.com/stuntrally/stuntrally3/issues)).
- 🌏Improving a translation to a language (on [Weblate](https://hosted.weblate.org/projects/stunt-rally-3/stunt-rally-3/), [Localization](Localization.md)).
- 💭Constructive discussions and honest opinions about features, etc.
- 💡Lastly new ideas or features (since there are already *plenty* in [Tasks](https://stuntrally.tuxfamily.org/mantis/view_all_bug_page.php) and [Roadmap](Roadmap.md)).
- 💡Lastly new ideas or features (since there are already *plenty* in [Tasks](Tasks.md) and [Roadmap](Roadmap.md)).


Below is a list of **bigger** focused contributions:
Expand All @@ -23,7 +23,7 @@ If you know C++, [Ogre-Next](https://forums.ogre3d.org/viewforum.php?f=25) (3.0
and preferably could handle some of the [Roadmap](Roadmap.md) tasks.
Details for tools and sources are in [Developing](Developing.md).
Own ideas could also go into SR3, just need some discussion first.
Most ideas are already in [Tasks](https://stuntrally.tuxfamily.org/mantis/view_all_bug_page.php). Sorted by P (priority): 1 is most important, higher are less so.
Most ideas are already in [Tasks](Tasks.md). Sorted by P (priority): 1 is most important, higher are less so.

Medium changes can go through [pull requests](https://github.com/stuntrally/stuntrally/pulls).
For those with more time and effort, commits to main branch will be possible.
Expand Down Expand Up @@ -86,8 +86,7 @@ This section describes the procedure to get your code (fixes, patches, new featu
This assumes you have already cloned our code and done something with it and now are ready to share your stuff.

If you don't know what to do, but want to help, check out the repo page [Contributing](Contributing.md),
[ToDo](https://stuntrally.tuxfamily.org/mantis/view_all_bug_page.php) with programming tasks with descriptions (sort by priority P, 1 is critical, higher are less important),
and also [Roadmap](Roadmap.md) for next version(s).
[Tasks](Tasks.md) with programming tasks with descriptions, and also [Roadmap](Roadmap.md) for next version(s).


## Prerequisites ##
Expand Down
6 changes: 2 additions & 4 deletions docs/Developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This guide can be useful if you want to:

- Many _ToDo:_ tasks are added BTW of topics in this guide file. It may not reflect very latest changes.
- **Fast** updated list with more items, but *shorter* info, is on [Roadmap](Roadmap.md), also used for planning what to do next.
- More in **slow** [Task list](https://stuntrally.tuxfamily.org/mantis/view_all_bug_page.php) with general info (sorted by P (priority), 1 is most important).
- More in **slow** [Tasks list](Tasks.md) with general info (sorted priority).
- Lastly there are plenty of `todo:` or `fixme` places marked in sources.

### Rendering support
Expand Down Expand Up @@ -379,8 +379,6 @@ VDrift simulation, main update code in [cardynamics_update.cpp](../src/vdrift/ca
SR's own code for non-car vehicles are in: `SimulateSpaceship(` 🚀, `SimulateSphere(` 🔘, and all hovering in `SimulateHover(`.
Key places in code (that change simulation) for such special vehicles are marked with `//V*`.

Few possible tasks _ToDo:_ [here](https://stuntrally.tuxfamily.org/mantis/view.php?id=17).


### Replay 📽️

Expand All @@ -393,7 +391,7 @@ More detail in [CGame.h](../src/game/CGame.h) sections with vars for this.
Sound manager code in `src/sound/`. Uses [OpenALSoft](https://github.com/kcat/openal-soft).
It is based on [RoR's](https://github.com/RigsOfRods/rigs-of-rods/tree/master/source/main/audio) code, but very reduced. It completely replaced old VDrift's code.

**_ToDo:_** [Task here](https://stuntrally.tuxfamily.org/mantis/view.php?id=1).
**_ToDo:_** [Task here](Tasks.md#sounds).


----
Expand Down
9 changes: 4 additions & 5 deletions docs/General.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ For future plans see [Roadmap](Roadmap.md) and developer [Tasks](Tasks.md) - The
### Media

**[Videos](https://www.youtube.com/user/TheCrystalHammer)** from gameplay and track editor tutorials.
[Screenshots **gallery**](https://cryham.org/stuntrally/gallery/) (from all versions).
Old development galleries linked below (lots of funny screenshots).
[Screenshots **gallery**](https://cryham.org/stuntrally/gallery/)
and from [all versions](https://cryham.org/stuntrally/galleries/), including old development galleries (lots of funny screenshots).

Creator and main developer [CryHam's website](https://cryham.org/).

Expand All @@ -26,7 +26,7 @@ _Old_ presentation document of the project's past (aka SR 2.6 book, 196 pages),

### Feedback

Is in [Readme.md](../Readme.md)
Is in [Readme.md](../Readme.md#feedback) (chat, forum etc).

----
### Technologies and Libraries used
Expand All @@ -44,5 +44,4 @@ Both road and SR Track Editor are fully implemented our own code by CryHam.

#### Website

Website is made with [CMS Made Simple](https://www.cmsmadesimple.org/), [DokuWiki](https://www.dokuwiki.org/dokuwiki) and [Mantis Bug Tracker](https://www.mantisbt.org/).
Hosted on [TuxFamily](https://www.tuxfamily.org/en/about).
SR website is made using [WordPress](https://wordpress.org) just like [cryham's](https://cryham.org) website.
34 changes: 17 additions & 17 deletions docs/Roadmap.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,27 @@
_List of things **to do**, planned for next releases._

This is the latest, fast updated list.
More in [Tasks tracker](https://stuntrally.tuxfamily.org/mantis/view_all_bug_page.php?page_number=1) with older tasks too and some more detail.
More in [Tasks](Tasks.md) with older tasks too and more detail text.

Priorities marked: 1 ! , 2 `crucial`, 3 **Next or Big**, 4 _Important_, 5 normal


### 3.4

🌧️ Ambient [Sounds](https://stuntrally.tuxfamily.org/mantis/view.php?id=1): rain, wind, forest etc
🌧️ Ambient [Sounds](Tasks.md#sounds): rain, wind, forest etc
📦 object *hit* sounds🔊

fix *tracks*:
MogFoss waterfals up, Preyth bld up-
Tiny, Mudflats, Knotted - ssao bad alpha bridge
MiningCity, KapabaRiv, Overgrowth, Glitchy - road segs white blend transp/invisible
MadMntnDark then loadd Temple - jng tex bad grn-blue
MadMntnDark then load Temple - jng tex bad grn-blue

win *installer* needs admin for vcredist, drop ask, or elevate on run
upd website gallery

*tire trails* clr, no uv tex-

! auto road/ter **Surface**: Particles, trail, fix clr, sounds, from `presets.xml` not per track
! `auto` road/ter Surface: **Particles**, trail, fix clr, **sounds**, from `presets.xml` not per track
new road particles

### Data
Expand Down Expand Up @@ -92,7 +91,7 @@ or add *new* code for:
### Tracks

New **tracks**, also with **fields**
walls repeat mul uv, more mtr, wall *types*, [link](https://stuntrally.tuxfamily.org/mantis/view.php?id=6)
walls repeat mul uv, more mtr, wall *types*, [task](Tasks.md#road-sides-walls)

💎Add gems to tracks, more types 3d
xml par continuous?, logic btn continue, hid collected gems on start?
Expand Down Expand Up @@ -123,7 +122,7 @@ glass pipes not fogged?
rqg rivers after water
river alpha fade last segs

! 🌊refract, depth: pass projmatrix `NOT` **inverse**
! 🌊refract, depth: pass projmatrix not **inverse**
waterfalls refract `cuts` off above cam y
underwater top has no surface, refract

Expand All @@ -144,13 +143,13 @@ car glass reflect cube **sky pos** bad on Test1-Flat?
fix .car thrusters lights pos
**hide** flares for in car camera

old [Splitscreen](https://stuntrally.tuxfamily.org/mantis/view.php?id=26) issues
old [Splitscreen](Tasks.md#splitscreen-per-viewport) tasks


----
### New game stuff✨

🏆 new [game Modes](https://stuntrally.tuxfamily.org/mantis/view.php?id=21): [**Career**](https://forum.freegamedev.net/viewtopic.php?f=79&t=5211)
🏆 new [game Modes](Tasks.md#gameplay-modes): [**Career**](https://forum.freegamedev.net/viewtopic.php?f=79&t=5211)
Score for: drift (sliding on road), air time (jumps etc), hitting dynamic objects

🕹️ New **Game** elements:
Expand All @@ -168,9 +167,9 @@ test, big, move to bullet3?
----
### 🟢 Ogre new

🌊! Terra `waves`, vehicle deform tex/compute-, fluid *particles*
🌊! Terra `waves` [task](Tasks.md#water-waves), vehicle deform tex/compute-, fluid *particles*

💦 Vehicle, wheels **dirt**,mud and **damage** *shader*, by dynamic paint, detail texture
💦 Vehicle, wheels **dirt**,mud and **damage** *shader* [task](Tasks.md#damage-and-dirt), by dynamic paint, detail texture

🕳️ Terrain new **ssao map** added to shadowmap: normals, ssao pass, from top view
GI for terrain [issue](https://github.com/OGRECave/ogre-next/issues/475)?
Expand Down Expand Up @@ -241,21 +240,22 @@ redo or replace lowest quality meshes: , skyscraper* 🏢

🌟 Sceneries: Spring blooming🌸 trees, Fractal, Organic?, Candy?

[Horizons](https://stuntrally.tuxfamily.org/mantis/view.php?id=11), add to rest of tracks
[Horizons](Tasks.md#horizons), add to rest of tracks


----
### old Tasks

Basically all [Tasks](https://stuntrally.tuxfamily.org/mantis/view_all_bug_page.php) with priority 1 to 12.
Basically all [Tasks](Tasks.md) with priority 1 to 12.

#### Graphics

🏞️ [Rivers/waterfalls](https://stuntrally.tuxfamily.org/mantis/view.php?id=7)
[Particles](https://stuntrally.tuxfamily.org/mantis/view.php?id=2)
🏞️ [Rivers/waterfalls](Tasks.md#rivers-waterfalls)
[Particles](Tasks.md#particles)
⚡ lightning weather: mesh line, thunder sound, light, hdr glow-

#### Meh
ed roads: [split](https://stuntrally.tuxfamily.org/mantis/view.php?id=4), checkpoints, merge?
ed roads: [split](Tasks.md#road-splitting), checkpoints, merge?
sim new poses _interpolation_?
[Pace notes](https://stuntrally.tuxfamily.org/mantis/view.php?id=14) - game Info window for all signs
[Pace notes](Tasks.md#pacenotes)

2 changes: 1 addition & 1 deletion docs/_menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
#### Developers

[Roadmap](Roadmap.md)
📚[Tasks](http://stuntrally.tuxfamily.org/mantis/view_all_bug_page.php)
📚[Tasks](Tasks.md)
🤗[Release Process](Release.md)

🏛️[old SR 2.x docs](https://github.com/stuntrally/stuntrally/blob/master/docs/_menu.md)

0 comments on commit 3e6d739

Please sign in to comment.