VsWiki - User contributions [en]

Development:GitHub Tree

2024-12-28T22:21:36Z

Temporalbeing: Created page with "{{parent_link| |parent=Development}} The code is organized in GitHub very differently than it was in SVN for SourceForge. The team has broken the project into two major p..."

{{parent_link|
|parent=[[Development]]}}

The code is organized in GitHub very differently than it was in SVN for SourceForge. The team has broken the project into two major parts and enabled them to be released on their own.

If you are interested in contributing then we highly suggest you checkout the following resources:
* [https://docs.github.com/en/get-started GitHub: Getting Started]
* [https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally GitHub: Pull Requests]
* [https://git-scm.com/book/ The Git Book (by the Git team)]
* [https://docs.gitbook.com/ Git Book]

The following will also be very relevant:
* [https://github.com/vegastrike/Vega-Strike-Engine-Source/blob/master/README.md Vega Strike Engine: Compiling]

== Game Assets ==

The Vega Strike Engine can run multiple different game assets. Here is a list of the currently known assets:
* [https://github.com/vegastrike/Assets-Production VS: Upon the Coldest Sea] (Actively maintained)
** [https://github.com/vegastrike/Assets-Masters VS:UtCS Master Data] (Passively maintained)
* [https://github.com/vegastrike/vsu-black-paralysis VS Universe: Black Paralysis] (Planned to be restored)
* [https://github.com/pwcu/privateer_wcu PWCU] (Privateer Wing Commander Universe) (Actively maintained)

== Game Engine ==

The [https://github.com/vegastrike/Vega-Strike-Engine-Source Vega Strike Engine (VSE)]:

== Branches and Tags ==

The Vega Strike Engine and Vega Strike Production Assets are maintained using the following branch and tag structures:

=== Branches ===
* master - the primary development branch

Each release has its own Maintenance Release Branch:
* [https://github.com/vegastrike/Vega-Strike-Engine-Source/tree/0.5.x 0.5.x] - a mirror of the Subversion 0.5.x code when it was ported to GitHub
* [https://github.com/vegastrike/Vega-Strike-Engine-Source/tree/0.5.3 0.5.3] - the last 0.5.x release on Subversion
* [https://github.com/vegastrike/Vega-Strike-Engine-Source/tree/0.6.x 0.6.x] - the first release on GitHub with updated dependencies
* [https://github.com/vegastrike/Vega-Strike-Engine-Source/tree/0.7.x 0.7.x] - new 'vegastrike-engine' executable, legacy 'vegastrike' kept for auto-find behavior
* [https://github.com/vegastrike/Vega-Strike-Engine-Source/tree/0.8.x 0.8.x] - support for Python 3
* [https://github.com/vegastrike/Vega-Strike-Engine-Source/tree/0.9.x 0.9.x] - drop support for Python 2, officially restore builds for Windows and Mac

The development team maintains the current (master), the prior release, and at times and up-coming releases. For example, the 0.9.x branch was cut in late 2023 and the 'master' branch was moved to '0.10.0'; however, the development team took a long time to meet the goals for releasing 0.9.x and thus even in late 2024 the branch was still an up-coming release; during this time the 0.8.x maintenance branch continued to be supported. Once 0.9.x is released the 0.8.x branch will leave active support by the development team. Generally the team aims to keep minimize the length of time a release is in the up-coming release state.

==== Release Process ====

The 'master' branch will always be the next release. When enough release targets are met the team will cut a new release branch to finish stabilizing a specific release. At that time the 'master' branch will be moved to the next release so development can continue forward while the release is being stabilized. The team will make a series of releases (alpha, beta, release candidates) based on the reports of stability until a final release is made using the `x.y.0` version. Bug fixes after that release will increment the final digital ('x.y.0' to 'x.y.1', etc); these releases may or may not see the candidates for releases.

===== Release Series =====

Alpha releases are used to verify that the release packages can be generated and their versions match the expected versions; ensuring that the system is generating the correct targets.

Beta releases are used to test functionality.

Release Candidates (RC) releases are used to show confidence in a release before making the final cut.

The last RC candidate should have the same Git Hash as the final release. This should generally hold true between the earlier releases in the cycle too (alpha to beta, beta to RC), but is not required to be so. There may, however, be some changes between when the branch is cut and the first alpha release is made.

=== Tags ===

Each release is tagged in git. We try not to change the commits the tags point to unless absolutely necessary.
The tags can be found under the 'releases' page for each project.

== Bringing it together ==

Starting with the 0.7.x release the VSE developers added a new 'vegastrike-engine' executable that requires the specification of the game assets to be run. The game assets are also no longer linked in the 'data' directory of the VSE code as they were with the code in SVN so users will need to checkout both projects on their own.

Game users will continue to be able to use the 'vegastrike' executable to auto-find the VS:UtCS code as was done with the earlier releases (0.5.x and previous).

Development

2024-12-28T21:29:20Z

Temporalbeing: /* Code-related Development */

{{Wiki_Nav_Index}}

=Development & Modding=

==Developer information pages==
General information on contribution:
* [[HowTo:Contribute|The Vega Strike Contributor's Guide]]
* [[Database:GPUs|GPU information database]]
* [[HowTo:MOD|How to create MODs]]
* [[Development:File_Structure|File and Directory Structure]]

==Status/task list pages==
* [[Development:3D_Models|3D Models]] - Organisation and contribution information.
* [[Development:2D_Images|2D Images]] - Organisation and contribution information.
* [[Development:Roadmap|Roadmap]] - The Vega Strike development roadmap.
* [[Development:Compatibility]] - Making sure the game works on all hardware
* [[Development:Rebalance]] - Information and task list for the Rebalance.
* [[Development:Performance]] - Goals to achieve required performance
* [[Development:AI Navigation]] - Overhauling the ships' navigation routines
* [[Development:Misc Engine Work]] - Various engine and backend work information.
* [[Development:Ogre]] - Information on the OGRE port.

= Artistic Contribution =

===Art Guidelines===
Please read this '''[[Development:Graphics_Requirements]]''' page first before continuing to the specific requirements.
See also: [[Links:Graphic_Applications]] and [[Links:3D_Applications]] for applications listings.

Further, the [[Artstyle_guides|Art Style Guides]] might prove useful during your creationist endeavors.

===Audio===
There are also guidelines for sound and music creation available in '''[[Development:Audio]]'''.

===3D Models===
The modeling related information is just being restructured.
* [[Development:Model Guidelines|'''Guidelines Portal for Creating 3D Models''']] is the main page for complete guidance on developing ship and installation models for Vega Strike
** [[Development:3D_Models|3D models list and status]]

=== Space Scapes ===
* [[Development:Orbital Planet Surfaces|Orbital Planet Surfaces]] - General guidance for development of planet surfaces visible from orbit.
* [[Development:System_Backgrounds|Generating star system backgrounds]]
* [[Development:Base_Backgrounds|Creating and adding backgrounds for bases, planets, or capital ships]]

=== Cargo ===
* [[Development:Cargo (graphics)|Creating Cargo Graphics]] - Images to be displayed in the trading interface for cargo items.
** [[Cargo]] - Detailed descriptions of cargo items, listed by category.
* [[Development:Balancing|Faction Balancing]] - General guidelines to keep in mind when play balancing the Vega Strike factions.

=== Other Graphics ===
* [[Development:Logos & Signage|Logos & Signage]]

= Python Scripting =

=== Quests & Campaigns ===
* [[Development:Quests_&_Campaigns|Quests & Campaigns]] Reference portal for creation of campaigns, missions, quests & adventures.
** [[Development:Quests|Quests]] Creating quests and adventures
** [[Development:Missions|Developing Missions]] Creation of missions
** [[Development:AIScripts|Developing AI Behaviors]] Customizing AI combat reactions
** [[Development:Campaigns]] Making campaigns

=== Other Scripts ===
* [[HowTo:Edit News|Editing News]]
* [[HowTo:Add Conversations|Adding Conversations]]
* [[Development:Base_Backgrounds|Changing Base Backgrounds and Base Computer GUI]]

= Data Modding =

=== Game Assets ===
* [[HowTo:Edit_units.csv| Editing units.csv]]
* [[HowTo:Make Weapons|Adding new weapons to the game]]
* [[HowTo:Add Cargo|Adding new cargo to the game]]
* [[HowTo:Add Descriptions|Putting ship and goods descriptions into the game]]
**[[HowTo:Edit master_part_list.csv|Editing the Master_part_list.csv file]]
* [[HowTo:Edit Systems|Creating or editing star systems]]
* [[HowTo:Make Splash Screens|Making splash screens that display at startup]]
* [[HowTo:Edit faction relationships|Edit the relationships between the existing factions]] (the <code>factions.xml</code> file)
* [[HowTo:Add Upgrades|Adding new upgrades to the game]]
* [[HowTo:Nav Computer Interface|Edit the navigation computer interface]]
* [[HowTo:Create_Cockpit_in_Wings3d|Creating a 3D cockpit for your ship]]
* [[HowTo:Edit_HUDs|Editing HUDs, placing radars]]

=== Events ===
* [[HowTo:Add Conversations|Adding more conversation lines to the game]]
* [[HowTo:Edit News|Creating or editing news events]]
* [[HowTo:Edit AI|Creating or editing Ship AI's]]

===Configuration ===
* [[Manual:Config:Advanced:Variables|Configuration Variables]]
* [[CONFVAR|CONFVAR - Complete Variable Listing]]

===Internationalization/Localisation-related===
* [[Development:Translations|Translation projects]]

=== Modding Tools ===
* [[Development:Scripts & Tools|Scripts & Tools]] - to make your life easier
** [[Development:Tools:UnitConverter|Unit Converter Manual]] - tool to convert Wavefront obj files to bfxm format including texture conversion, units stats editor, and visualization with Vega Strike.
** [[Development:Script:obj2obj converter|obj2obj converter]] (Perl, commandline) - Converts obj files to cockpit files. or extracts tag-data from the models. (''At least that's what is planned, Testing under Win32/Linux. [[User:pontiac|Pontiac]]'')
* [[OOG_Tools|Out-Of-Game Player Tools]]

=== Front End ===
* [[HowTo:Take Screenshots|Taking really awesome screenshots]]

= Vega Strike The Game Mechanisms =
* [[Development:Realism vs Believability|Realism vs Believability]]
* [[Development:Economy|Economy]] - How ingame economy should work.
* [[Development:Political system|Political system]]

= Code-related Development =
* [[Development:Dependencies|Dependencies]] - A guide to system dependencies, broken down by subsystem.
* [[Development:SVN Tree|SVN Tree]] - A guide to the layout of the Subversion tree for the original project.
* [[Development:GitHub Tree| GitHub Tree]] - A guide to the layout of the GitHub organization.
* [[Development:Code style|Code style]] - A guide/manual to write code for Vegastrike that fits in and is readable.
* [[Development:Network|Network]] - Everything network related goes in here.
** [[Development:Network:Packet format|Packet format]] - A description of the packet format that had been implemented a few years ago.
** [[Development:Network:Todo|Todo]] - What still needs to be done.
** [[Development:Network:Testing|Testing]] - Testing the network code.
* [[Development:Keyboard layout|Keyboard layout]] - Discuss and display new keyboard layouts here.

=See also=
* [[HowTos]]
* [[FAQ:Feature_Requests|Feature Requests]]
* [[Development:Audio#Voice_Acting]]

[[Category:Development]]

Vegastrike:Project

2024-12-28T21:25:33Z

Temporalbeing: /* Active Team */

Project Information

=About=
Vega Strike is an Open Source 3d Space Simulator. Work is proceeding on both the Vega Strike game engine and a Vega Strike Universe game data set. Both, engine and data, are in a playable state, but under continuous development.

The Vega Strike engine serves as the foundation for the Parallel Universe, Privateer Gemini Gold, Privateer Remake, Vega Trek, and Pi Armada projects, whose websites can be reached via the sidebar to the right on the project web page.

= Vision =

We enjoy the futuristic genre, and we enjoy creating content for this genre in an interesting, vast, and profoundly complex but believable universe with endless expansion and enhancement possibilities.

We want to create a generic, open, and free space simulator game of outstanding quality, both in technology and content.

We want to be the vehicle for the creation and recreation of other space games and provide the possibility for users to create their own stories.

= Mission =

We have three development drivers:
* The Vega Strike Game
* The Modding capability
* The Engine that enables both

VS (the engine) is a vehicle for groups of people to produce content in a set of genres that they enjoy creating and playing.

The particular universe (VS game) that the Minister of Information (jackS) has been working on for some time now should be the target game, to help focus and separate required features from nice features. We also want to create an entangling, profound, and believable space game whose story is set in the Vega Strike Universe.

We want to maintain close relationship with and provide to the freedom loving community a moddable open source space simulation engine that can be used to create other independent space games.

We develop feature sets for the underlying content that requires those features: a campaign, a story, a well defined economy model, well defined game play mechanics, modding requirements.

Our approach is not myopic because of a particular perception as to what resources/technology will be available.

Users can write their own stories for the universe and share them around - and if they're good we can include them as well. Think of it as universe supporting easy-to-make fan-fiction (which can include mod-based fiction).

Factions are given the ability to make their own decisions ... God's (campaign) commands are suggestions ... the campaign evolves as the players force it, and the goals need to be written to handle that.

Shortly, Vega Strike will become a space combat/simulator game and engine with fully dynamic universe creation, scriptable ai responses with dynamic decision ability, completely non-determinant campaigns, fully functional economic system that responds to the real-time gameplay state of
the universe, shader-fied openGL graphics with nifty special effects.

"One universe, infinite possibilities"

= Features =

See [[Vegastrike:Features]]

= Active Development Team =

The original dev team lead the work from the start of the project until about 2015.
Between 2015 and 2019 most of the team moved on to other things, and Vega Strike lagged behind.
We continue to be thankful to those that ran and contributed to the project over that time
and the massive effort they did to create a wonderful Space Simulation Game.

Around 2015 the project moved from SourceForge over to GitHub and in 2019 a new team
took the lead to bring the project back to life.

== The original team ==

Vega Strike is forever indebted to the following individuals and myriad of contributors
that started it.

=== Project Leads and Lead Developers ===
* Daniel R Horn aka ''hellcatv'',''danielrh'' (overall coordination, lead programming, ...)
* Patrick Horn aka ''ace123'' (lead development, multiplayer, python, forum support)
* Jack Sampson aka ''jackS'' (Minister of Information, VS Universe development, art directing)

=== Programmers and Developers ===
* Claudio Freire aka ''klauss'', ''klausfreire'' (engine and python development)
* Ed Sweetman aka ''safemode'' (engine development)
* aka ''pyramid'', ''pyramid3d'' (art development, python scripting, documentation)

== Active Team ==
* Benjamen Meyer aka ''TemporalBeing'' (project management, technical decisions, ...)
* Roy Falk (primary developer, Linux)
* Stephan G Tuggy (developer, Mac & Windows)
* Denis Belanger aka ''Loki1950'' (historical lead)
* Nachum Barcohen aka ''nabaco''

The team is forever indebted to Denis Belanger for helping to contact us with the former
team and enabling us to continue their work, as well as providing historical information and insights.

== Developers and Contributors ==

There are also developers that have in the past but do not contribute actively at this moment. Those are listed in the credits.

Besides the developers, there is a large number of contributors from the community, be it for the engine or art and other content type for VS game.

And not to forget the modders, who give significant direction and contribution to engine development.

See: [[Vegastrike:Credits]]

= Artistic Organization =
This is the artistic organization for unit model (ships, bases) development in Vega Strike - Upon The Coldest Sea.

'''Art Director''' - provides the design briefs, gives the model final approval before it goes into the game.
* jackS

'''Art Administrator''' - knows what models go where, organizes the wiki, prioritizes development
* pyramid

'''Technical Liaison''' - tells artists what to do with regard to technical stuff
* chuck_starchaser

'''Concept Artists''' - come up with concept art
* Fendorin

'''Modeling Artists''' - model the ships and other assets
* Fendorin - senior modeling artists
* Deus Siddis
* rivalin

'''Texture Artists''' - texture the ships and stations
* Fendorin - senior texture artists

'''Voice Artists''' - provide speech voices
* [[User:Turbo|Turbo]] (tutorial quest voice, alien speech audio)
* CLoneWolf (andolian speech audio)

'''Data Integrators''' - contributors that integrate the models into the game data, fill in missing simple textures and placeholders, do file format conversions
* jackS
* esgaroth
* pyramid

'''Front End Artist''' - does overlays, wallpapers, screen savers, renders, runs the ModDB page, a deviantart page, conceptart.org thread, Game-Artist.net thread
* rivalin

= Project Setup =

== Open Source Principles ==

We often hear the complaint that features don't get implemented for a long time though they are being requested over and over again.

Being an open source community, most developers or contributors have their day-time jobs or commitments. Time is a scarce resource for those people and naturally they tend to prioritize their work on things that they are personally most interested in. Active developers do not dictate what gets contributed and what doesn't. The dictate is solely coming from contributions.

The really best way to see a particular feature implemented quickly is to pull up your sleeves and start implementing them, first integrating with your local VS copy, and when a particular feature is working satisfactory, submit it to one of the active developers for inclusion. Bear in mind that only, and only working code will get committed fast. If code or data needs additional work it will most certainly have to wait either for developer time or interest.

In this way, contributors who submit a lot will become developers.

Don't know how and what to contribute? Have a look at the [[HowTo:Contribute]] page for a starter.

== Communication Structure ==

Developers communicate between themselves on a need basis via forum personal messages, email, and irc. In addition there are frequent project meetings scheduled to discuss online ongoing developments.

In addition, we communicate with the community primarily through the forum, the web page, the dev blogs, the wiki, and equally through pm's and irc.

= History =

I read it somewhere but can't find the text right now.

In any case, it was ''hellcatv'' who started it all. The first news entry on the project page is from March 1, 1998 with news about flight engine completion, basic AI functionality, and 4 available ships. This suggests that development was going on already before that time.

= On The Web =

* [https://github.com/vegastrike GitHub] organization.
* [https://github.com/vegastrike/Vega-Strike-Engine-Source/releases Vega Strike Engine] Releases.
* [https://github.com/vegastrike/Assets-Production/releases VS: Upon The Coldest Sea] Game Asset Releases.
* [http://en.wikipedia.org/wiki/Vega_Strike Vega Strike] Wikipedia entry.
* [http://www.youtube.com/results?search_query=Vega+Strike&aq=f VS on YouTube].
* [http://www.facebook.com/pages/VegaStrike/188522714499479 Vega Strike] on facebook.
* [http://www.linuxlinks.com/article/20080523214626193/VegaStrike.html Vega Strike] on linuxlinks.com.
* [http://www.onlylinuxgames.com/vega-strike/ Vega Strike] on OnlyLinuxGames.
* 2010: [http://www.makeuseof.com/tag/space-adventures-vega-strike/ Go On Space Adventures With Vega Strike] in makeuseof.
2010: [http://www.dodownload.com/games/simulator/vega+strike.html Vega Strike 0.5] on dodownload.
* 2009: [http://blog.eracc.com/2009/09/24/gnulinux-gaming-vega-strike-for-all/ GNU/Linux Gaming – Vega Strike for All] on The ERACC Web Log.
* 2009: [http://www.webupd8.org/2009/10/free-open-source-space-simulation-game.html Vega Strike: Free, Open Source Space Simulation Game for Windows, Linux and Mac OSX].
* 2009 (DE): [http://www.linux-community.de/Internal/Artikel/Online-Artikel/Das-Spiel-zum-Wochenende-Vega-Strike Das Spiel zum Wochenende: Vega Strike ] on linux-community.
* 2007: [http://www.freesoftwaremagazine.com/articles/vegastrike Vega Strike - My kind of fun] in the [http://www.freesoftwaremagazine.com/ Free Software Magazine]
* 2003: [http://www.insidemacgames.com/news/story.php?ArticleID=6826 Vega Strike Released for Mac OS X] on insidemacgames.
* [http://tvtropes.org/pmwiki/pmwiki.php/Main/VegaStrike Vega Strike] on tvtropes.
* [http://linux.about.com/od/softgame/fr/fr_VegaS.htm Linux Game: Vega Strike] on About.com.
* [http://www.reloaded.org/download/Vega-Strike/40/ Vega Strike] on reloaded.org.
* [http://www.absoluteastronomy.com/topics/Vega_Strike Vega Strike] on absoluteastronomy.

= Roadmap =
See [[Development:Roadmap]]

Vegastrike:Project

2024-12-28T21:13:52Z

Temporalbeing:

Project Information

=About=
Vega Strike is an Open Source 3d Space Simulator. Work is proceeding on both the Vega Strike game engine and a Vega Strike Universe game data set. Both, engine and data, are in a playable state, but under continuous development.

The Vega Strike engine serves as the foundation for the Parallel Universe, Privateer Gemini Gold, Privateer Remake, Vega Trek, and Pi Armada projects, whose websites can be reached via the sidebar to the right on the project web page.

= Vision =

We enjoy the futuristic genre, and we enjoy creating content for this genre in an interesting, vast, and profoundly complex but believable universe with endless expansion and enhancement possibilities.

We want to create a generic, open, and free space simulator game of outstanding quality, both in technology and content.

We want to be the vehicle for the creation and recreation of other space games and provide the possibility for users to create their own stories.

= Mission =

We have three development drivers:
* The Vega Strike Game
* The Modding capability
* The Engine that enables both

VS (the engine) is a vehicle for groups of people to produce content in a set of genres that they enjoy creating and playing.

The particular universe (VS game) that the Minister of Information (jackS) has been working on for some time now should be the target game, to help focus and separate required features from nice features. We also want to create an entangling, profound, and believable space game whose story is set in the Vega Strike Universe.

We want to maintain close relationship with and provide to the freedom loving community a moddable open source space simulation engine that can be used to create other independent space games.

We develop feature sets for the underlying content that requires those features: a campaign, a story, a well defined economy model, well defined game play mechanics, modding requirements.

Our approach is not myopic because of a particular perception as to what resources/technology will be available.

Users can write their own stories for the universe and share them around - and if they're good we can include them as well. Think of it as universe supporting easy-to-make fan-fiction (which can include mod-based fiction).

Factions are given the ability to make their own decisions ... God's (campaign) commands are suggestions ... the campaign evolves as the players force it, and the goals need to be written to handle that.

Shortly, Vega Strike will become a space combat/simulator game and engine with fully dynamic universe creation, scriptable ai responses with dynamic decision ability, completely non-determinant campaigns, fully functional economic system that responds to the real-time gameplay state of
the universe, shader-fied openGL graphics with nifty special effects.

"One universe, infinite possibilities"

= Features =

See [[Vegastrike:Features]]

= Active Development Team =

The original dev team lead the work from the start of the project until about 2015.
Between 2015 and 2019 most of the team moved on to other things, and Vega Strike lagged behind.
We continue to be thankful to those that ran and contributed to the project over that time
and the massive effort they did to create a wonderful Space Simulation Game.

Around 2015 the project moved from SourceForge over to GitHub and in 2019 a new team
took the lead to bring the project back to life.

== The original team ==

Vega Strike is forever indebted to the following individuals and myriad of contributors
that started it.

=== Project Leads and Lead Developers ===
* Daniel R Horn aka ''hellcatv'',''danielrh'' (overall coordination, lead programming, ...)
* Patrick Horn aka ''ace123'' (lead development, multiplayer, python, forum support)
* Jack Sampson aka ''jackS'' (Minister of Information, VS Universe development, art directing)

=== Programmers and Developers ===
* Claudio Freire aka ''klauss'', ''klausfreire'' (engine and python development)
* Ed Sweetman aka ''safemode'' (engine development)
* aka ''pyramid'', ''pyramid3d'' (art development, python scripting, documentation)

== Active Team ==
* Benjamen Meyer aka ''TemporalBeing'' (project management, technical decisions, ...)
* Roy Falk (primary developer, Linux)
* Stephan G Tuggy (developer, Mac & Windows)
* Denis Belanger aka ``Loki1950`` (historical lead)
* Nachum Barcohen aka ``nabaco``

The team is forever indebted to Denis Belanger for helping to contact us with the former
team and enabling us to continue their work, as well as providing historical information and insights.

== Developers and Contributors ==

There are also developers that have in the past but do not contribute actively at this moment. Those are listed in the credits.

Besides the developers, there is a large number of contributors from the community, be it for the engine or art and other content type for VS game.

And not to forget the modders, who give significant direction and contribution to engine development.

See: [[Vegastrike:Credits]]

= Artistic Organization =
This is the artistic organization for unit model (ships, bases) development in Vega Strike - Upon The Coldest Sea.

'''Art Director''' - provides the design briefs, gives the model final approval before it goes into the game.
* jackS

'''Art Administrator''' - knows what models go where, organizes the wiki, prioritizes development
* pyramid

'''Technical Liaison''' - tells artists what to do with regard to technical stuff
* chuck_starchaser

'''Concept Artists''' - come up with concept art
* Fendorin

'''Modeling Artists''' - model the ships and other assets
* Fendorin - senior modeling artists
* Deus Siddis
* rivalin

'''Texture Artists''' - texture the ships and stations
* Fendorin - senior texture artists

'''Voice Artists''' - provide speech voices
* [[User:Turbo|Turbo]] (tutorial quest voice, alien speech audio)
* CLoneWolf (andolian speech audio)

'''Data Integrators''' - contributors that integrate the models into the game data, fill in missing simple textures and placeholders, do file format conversions
* jackS
* esgaroth
* pyramid

'''Front End Artist''' - does overlays, wallpapers, screen savers, renders, runs the ModDB page, a deviantart page, conceptart.org thread, Game-Artist.net thread
* rivalin

= Project Setup =

== Open Source Principles ==

We often hear the complaint that features don't get implemented for a long time though they are being requested over and over again.

Being an open source community, most developers or contributors have their day-time jobs or commitments. Time is a scarce resource for those people and naturally they tend to prioritize their work on things that they are personally most interested in. Active developers do not dictate what gets contributed and what doesn't. The dictate is solely coming from contributions.

The really best way to see a particular feature implemented quickly is to pull up your sleeves and start implementing them, first integrating with your local VS copy, and when a particular feature is working satisfactory, submit it to one of the active developers for inclusion. Bear in mind that only, and only working code will get committed fast. If code or data needs additional work it will most certainly have to wait either for developer time or interest.

In this way, contributors who submit a lot will become developers.

Don't know how and what to contribute? Have a look at the [[HowTo:Contribute]] page for a starter.

== Communication Structure ==

Developers communicate between themselves on a need basis via forum personal messages, email, and irc. In addition there are frequent project meetings scheduled to discuss online ongoing developments.

In addition, we communicate with the community primarily through the forum, the web page, the dev blogs, the wiki, and equally through pm's and irc.

= History =

I read it somewhere but can't find the text right now.

In any case, it was ''hellcatv'' who started it all. The first news entry on the project page is from March 1, 1998 with news about flight engine completion, basic AI functionality, and 4 available ships. This suggests that development was going on already before that time.

= On The Web =

* [https://github.com/vegastrike GitHub] organization.
* [https://github.com/vegastrike/Vega-Strike-Engine-Source/releases Vega Strike Engine] Releases.
* [https://github.com/vegastrike/Assets-Production/releases VS: Upon The Coldest Sea] Game Asset Releases.
* [http://en.wikipedia.org/wiki/Vega_Strike Vega Strike] Wikipedia entry.
* [http://www.youtube.com/results?search_query=Vega+Strike&aq=f VS on YouTube].
* [http://www.facebook.com/pages/VegaStrike/188522714499479 Vega Strike] on facebook.
* [http://www.linuxlinks.com/article/20080523214626193/VegaStrike.html Vega Strike] on linuxlinks.com.
* [http://www.onlylinuxgames.com/vega-strike/ Vega Strike] on OnlyLinuxGames.
* 2010: [http://www.makeuseof.com/tag/space-adventures-vega-strike/ Go On Space Adventures With Vega Strike] in makeuseof.
2010: [http://www.dodownload.com/games/simulator/vega+strike.html Vega Strike 0.5] on dodownload.
* 2009: [http://blog.eracc.com/2009/09/24/gnulinux-gaming-vega-strike-for-all/ GNU/Linux Gaming – Vega Strike for All] on The ERACC Web Log.
* 2009: [http://www.webupd8.org/2009/10/free-open-source-space-simulation-game.html Vega Strike: Free, Open Source Space Simulation Game for Windows, Linux and Mac OSX].
* 2009 (DE): [http://www.linux-community.de/Internal/Artikel/Online-Artikel/Das-Spiel-zum-Wochenende-Vega-Strike Das Spiel zum Wochenende: Vega Strike ] on linux-community.
* 2007: [http://www.freesoftwaremagazine.com/articles/vegastrike Vega Strike - My kind of fun] in the [http://www.freesoftwaremagazine.com/ Free Software Magazine]
* 2003: [http://www.insidemacgames.com/news/story.php?ArticleID=6826 Vega Strike Released for Mac OS X] on insidemacgames.
* [http://tvtropes.org/pmwiki/pmwiki.php/Main/VegaStrike Vega Strike] on tvtropes.
* [http://linux.about.com/od/softgame/fr/fr_VegaS.htm Linux Game: Vega Strike] on About.com.
* [http://www.reloaded.org/download/Vega-Strike/40/ Vega Strike] on reloaded.org.
* [http://www.absoluteastronomy.com/topics/Vega_Strike Vega Strike] on absoluteastronomy.

= Roadmap =
See [[Development:Roadmap]]

Development:Roadmap:0.6.0

2023-11-11T02:46:36Z

Temporalbeing:

NOTE: The Roadmap has moved to https://github.com/vegastrike/Vega-Strike-Engine-Source/wiki/Release-Road-Map.
The team has deviated significantly from the road map outlined below.

Vega Strike Upon the Coldest Sea stable version 0.5.0 was released on 2008-04-24.

This is a task list for intermediate 0.5.x releases. The stuff that should get done for each intermediate and until the 0.6.0 release.

=Generic Roadmap=
This roadmap is in need of further broken down into release specific tasks and assignment of those.

==Factions rework==
*Hierarchical factions (e.g. *_citizen, affects *)
*Allowing for non-factions (privateer is already our non-faction, we just need to fix some of the behavior.)
*Ability for player joining a faction

==AI==
*Faction-level AI (race / faction strategy)
*Micro AI (ship, fg, collision avoidance, tactical and navigational AI, roles definition)
*Macro (fg/faction)
* Flightgroups
** Classification (fleet, squadron, flotilla? etc. - something to differentiate between {5 plowshares} and {3 archimedes, 2 Tesla, 8 kahan, 20 schroedinger, 10 goddard, 5 watson} )
** Flightgroups should have subsets of ships that spawn together (combined arms)
* add another dimension to roles (attack AND defend/predator AND prey roles) instead of forcing both to be the same.
* AI spec drive use, escorts...

==Content Creation Tools==
*Prerequisite: straight XML, DTD (Document Type Definition) support
*System Editor
*Unit Editor
*CSV Editor (MPL, faction_ships.py, units.csv)
*Mission Editor
*Campaign Editor
*Config Editor

==Multiplayer==
*Persistence (systems, bases, flight groups, …)

==Building/Packaging==
*Move to cmake

==Documentation==
*Document the general function/flow of the game
*Engine internals, API (development documentation)
*Python bindings
*Should we use the builtin python documentation standards for documenting this stuff--maybe in the stubs folder?
*Faction documentation

==Engine rework==
*Audio subsystem overhaul
*Support for texture versions and normal map tangents
*Shader updates

=Release Roadmap=

There are up to three sections in each roadmap release chapter:
* '''VS Engine''' relates to: modifications to c++, shaders, and python code (not including missions), repository structure changes, packaging system, support tools, ogre version
* '''VS Data - Upon The Coldest Sea''' relates to: modifications to art, data, and mission scripts for Upon The Coldest Sea (sometimes also called Vega Strike The Game as opposed to Vega Strike The Engine
* '''Documentation & Mod Tools & Other''' relates to: documentation, wiki, project web page, masters repository, project management

Each task item should also have a prefixed tag in the form of ['''STATUS'''{=OPEN, ONGOING, DONE}, development-coordinator{=''username''}]

== 0.5.1 ==

'''VS Engine'''
* '''[FINISHED]''' (''safemode'') Separate bin and data tree structure. Note: those who have data4.x already, set your client to not pull external repos or cancel when it tries to download data4.x. Then move your current data4.x alongside /bin, renaming it to data. Updates should work seamlessly and recurse into /data and /bin afterwards. Newcomers can just pull win32.
* '''[FINISHED]''' (''ace123'') Rename data4.x to data and patch corresponding source code where necessary.
* '''[FINISHED]''' (''safemode'') Make a high quality graphics texture pack (''hqtextures'').
* '''[FINISHED]''' (''safemode'') Preparation of a cross-platform packaging system (cmake)
* '''[FINISHED]''' (''pyramid'') Updates to the shader (commit chuck's unit shader)
* '''[FINISHED]''' (''pyramid'') Correct rings generation to be always in the same plane
* '''[FINISHED]''' (''pyramid'') Support for target shield gauges definition
* '''[FINISHED]''' (''klauss'') Add support for "TexturePackingVersion" variable in xmesh
* '''[FINISHED]''' (''klauss'') Add support for techniques and far z-buffering correction
* '''[FINISHED]''' (''klauss'') Tangent support for normal maps
* '''[FINISHED]''' (''klauss'') sound refactoring phase I - basic functionality
* '''[FINISHED]''' (''klauss'') movie support
* '''[FINISHED]''' (''klauss'') CubeMap engine support
* Minor bug fixes.
** '''[FINISHED]''' (''ace123'') fixed player relationship with each faction in savegame
** '''[FINISHED]''' (''pyramid'') planetary rings are always coplanar
** '''[FINISHED]''' (''pyramid'') system ownership (faction) and sector info shown in RVDU and on map
** '''[FINISHED]''' (''pyramid'') python modules can be organized in additional subfolders (ai, mission, quests)

'''VS Data - Upon The Coldest Sea'''
* '''[FINISHED]''' (''pyramid'') Extensions renaming and standardization (.image, .texture, .sprite).
* '''[FINISHED]''' (''safemode'') Added some textures to hqtextures.
* '''[FINISHED]''' (''pyramid'') 8 faces for armor HUD images
* '''[FINISHED]''' (''pyramid'') Higher pay for combat missions.
* '''[FINISHED]''' (''pyramid'') Tutorial mission
* '''[FINISHED]''' (''pyramid'') splash screen grouping in pre-load and load ani directories
* '''[FINISHED]''' (''pyramid'') additional art (planet backgrounds for lava, forest, rock, and frigid_mud, new space backgrounds, hud images)
* '''[FINISHED]''' (''pyramid'') partial extensions renaming (cockpits, sprites, backgrounds)
* '''[FINISHED]''' (''pyramid'') Visually enhanced target shield gauges
* '''[FINISHED]''' (''pyramid'') New and updated cargo and upgrade image contributions
* '''[FINISHED]''' (''pyramid'') Standardized factions coloring scheme
* '''[FINISHED]''' (''pyramid'') Units subdirectories for vessels and installations
* '''[FINISHED]''' (''pyramid'') Various new ship models (Kahan, Knight, Tridacna, ....) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Various new installation models (Rlaan, Uln, Shaper, ...) [http://vegastrike.sourceforge.net/devblog/?p=36 see blog]
* '''[FINISHED]''' (''pyramid'') Porting of old quests to new engine; done for: blockade, dispute, shipyard bomb, slaver, surplus

'''Documentation & Mod Tools & Other'''
* '''[FINISHED]''' (''pyramid'') Unit Converter OBJ->BFXM - a mesher frontend.
* '''[FINISHED]''' (''pyramid'') Re-organization of vessels model requirements on [[Development:3D_Models]].

== 0.5.2 ==

'''VS Engine'''
* '''[OPEN]''' (''safemode'') Implement opcode's Ray Collider for ray-mesh collisions. (alongside bsp collider tunable via configure switch ala how opcode was done). Wont be turned on by default until 0.5.3
* '''[ONGOING]''' (''klauss'') More shader fixes, texture updates/additions.
* '''[OPEN]''' (''safemode'') Make tools and readers operate on a Proper XML format , this could be switchable via special comment at top of xml input. This is for backwards compat with non proper xml files in mods. To be made default in 0.5.5
* '''[OPEN]''' (''klauss'') sound refactoring Phase II would add mixer channels (a feature to get seamless blending with music, comm chatter and sfx)
* '''[OPEN]''' (''klauss'') put gfxlib into a class, or at the _very_least_ a namespace
* '''[ONGOING]''' (''chuck_starchaser'') CineMut shader family - v0.5
* '''[OPEN]''' ''(unassigned)'' Split CSV Support ([https://sourceforge.net/p/vegastrike/feature-requests/46/ feature #46])
* Minor bug fixes and improvements
** '''[FINISHED]''' (''pyramid'') Show, save, and load correct stardate
** '''[FINISHED]''' (''pyramid'') Corrected missing mission description for fixer missions
** '''[OPEN]''' (''ace123'') show ship sell price in user interface

'''VS Data - Upon The Coldest Sea'''
* '''[FINISHED]''' ''(pyramid)'' Added quit image with default key mapping
* '''[OPEN]''' ''(pyramid)'' New quests, missions, and campaigns
* '''[OPEN]''' ''(pyramid)'' Revision of planet types
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 0.5
* '''[ONGOING]''' (''pyramid'') Porting of old quests to new engine

'''Documentation & Mod Tools & Other'''
* '''[OPEN]''' (''???'') The Player's Guide tutorial glitches: Example: It says to buy the jump drive from Jenek...; The Alt-0 key

== 0.5.3 ==

'''VS Engine'''
* '''[OPEN]''' ''(safemode)'' Ray collider turned on, BSP stuff removed.
* '''[OPEN]''' ''(klauss)'' XGUI support for scripts
* '''[OPEN]''' ''(klauss)'' More shader fixes (should be pretty good by now), texture updates/additions
* '''[OPEN]''' ''(safemode)'' Continue to work on proper XML parsing in engine
* '''[OPEN]''' ''(safemode)'' update xml files in VS to be proper mode
* '''[OPEN]''' ''(safemode)'' setup tool
* '''[OPEN]''' (''chuck_starchaser'') CineMut shader family - v1.0
* '''[OPEN]''' ''(unassigned)'' Auto-escorts ([http://sourceforge.net/p/vegastrike/feature-requests/43/ feature #43])
* '''[OPEN]''' ''(unassigned)'' Units fully upgrade-based ([https://sourceforge.net/p/vegastrike/feature-requests/44/ feature #44])

'''VS Data - Upon The Coldest Sea'''
* '''[OPEN]''' ''(pyramid)'' Create custom systems with Homeworlds for races and factions
* '''[OPEN]''' (''chuck_starchaser'') Units re-texturing for CineMut texture packing version 1.0

== 0.5.4 ==

'''VS Engine'''
* '''[ONGOING SPECIFICATION]''' (''klauss, darkmage'') content creation tools: end user tools for helping with content creation. These should be a part of vegastrike code-base, to keep things in sync and reduce maintenance.
* make proper xml mode default, remove code to parse obsolete xml-ish code.
* Get codebase stabilized in prep for refactoring graphics code.
* '''[OPEN]''' ''(safemode)'' new wormhole effects
* '''[OPEN]''' ''(safemode)'' improved ship AI
* '''[OPEN]''' ''(klauss)'' cleaning up unused mesh legacy formats (mesh_bin.cpp, ...)
* '''[OPEN]''' ''(klauss)'' refactor particle systems
* '''[OPEN]''' ''(klauss)'' leverage particle systems for weapon, damage and explosion special effect
* '''[OPEN]''' ''(unassigned)'' revised turret control ([https://sourceforge.net/p/vegastrike/feature-requests/45/ feature #45])
* '''[OPEN]''' ''(unassigned)'' improved stealth and detection ([https://sourceforge.net/p/vegastrike/feature-requests/50/ feature #50])

'''VS Data - Upon The Coldest Sea'''
* '''[OPEN]''' ''(unassigned)'' [http://sourceforge.net/p/vegastrike/feature-requests/43/ Auto-escorts]: integrated interface in hangar/base

== 0.5.5 ==

'''VS Engine'''
* Refactor graphics code.
* ['''OPEN'''] (''ace123'') Make jump points be drawn on HUD only.

'''VS Data - Upon The Coldest Sea'''

== 0.5.6 ==

'''VS Engine'''
* Bug fixes.
* Texture additions/ etc
* Document refactored graphics and sound code.

'''VS Data - Upon The Coldest Sea'''

== 0.5.7 ==

'''VS Engine'''
* Thread graphics code and sound code with boost threads.
* Bug Fixing.

'''VS Data - Upon The Coldest Sea'''

== 0.5.9 ==

'''VS Engine'''
* sound refactoring Phase III would add environmental effects
* Bug Fixing.
* Documentation
* Credits

'''VS Data - Upon The Coldest Sea'''

== 0.6.0 ==

'''VS Engine'''
* Minor bug fixes from previous revision
* Packaging

'''VS Data - Upon The Coldest Sea'''
* documentation

[[Category:Roadmaps]]

Development:Dependencies

2023-09-18T03:05:00Z

Temporalbeing: warning about being out of date

{{parent_link|
|parent=[[Development]]
}}
----
WARNING: This document is out-of-date - at the very least the dependency versions are wrong.

----
This article is a work in progress, and is intended to become a centralized list of the tools needed for building vegastrike. Initially, it will document for the UNIX-based build system. Windows support will be added once the UNIX side is stable.

It will also document which portions of vegastrike are dependent on other libraries. Once completed, this should make optional building of portions of the code more doable.

[[DEPENDENCIES FOR VISUAL STUDIO ( WIndows ) ]]
==Auto* Tool Dependencies==
Auto* Tool Dependencies for UNIX like build systems
*automake - 1.6 or newer
*autoconf - 2.53 or newer
*aclocal - 1.6 or newer
*autoheader - 2.53 or newer

==Link Dependencies==
A few of the abbreviations used in this section
*DEP:Dependency
*DIR:Directory
*RE: Responsible Engineer

+vegastrike (DIR)
|
+-+doc (DIR)
| DESC: documentation describing VegaStrike and VegaStrike development
|
+-+English.lproj (DIR)
| (???, SLATED FOR REMOVAL IF NO ONE STEPS FORWARD WITH INFO)
|
+-+launcher (DIR)
| +-launcher (EXECUTABLE)
| USES: GTK 1.2
| USES: src/common/libvscommon.a
|
+-+m4scripts (DIR)
| RE: Brian Lloyd balloyd1@users.sourceforge.net
| (Scripts used for making Makefiles and configure)
|
+-+mission (DIR)
| | (???, SLATED FOR REMOVAL IF NO ONE STEPS FORWARD WITH INFO)
| +-select (EXECUTABLE)
|
|-+objconv (DIR)
| |(BUILT)
| +-+mesher (DIR)
| | +-mesher (EXECUTABLE)
| | USES: (NO DATA AVAILABLE)
| |
| +--add_suns (DIR)
| | (???)
| |
| +--basemaker (DIR)
| | (???)
| |
| +--flipunits (DIR)
| | (???)
| |
| +--imageproc (DIR)
| | (???)
| |
| +--MeshParse (DIR)
| | (???)
| |
| +--replace_bg (DIR)
| | (???)
| |
| +--starsystemgen (DIR)
| | (???)
| |
| +--starsystemreader (DIR)
| | (???)
| |
| +--3ds2xml (DATA FILE)
| |
| +--obj2xml (DATA FILE)
| |
| +--wcp2xml (DATA FILE)
| |
| +--trisort (EXECUTABLE)
| | (???)
| |
| +--replace (EXECUTABLE)
| | (???)
| |
| +--asteroidgen (EXECUTABLE)
| (???)
|
+--saveinterface (DIR)
| (???)This does not work. Does anyone need it? Slated for removal if no-one speaks up.
|
+-+src (DIR)
| +-+aldrv (DIR)
| | +--libaldrv (LIBRARY)
| | Low level sound driver library.
| |
| +--boost (DIR)
| | Contains a directory Other that seems to not be used.
| | libboost-python integration library using Boost 1.28
| |
| +--boost129 (DIR)
| | libboost-python integration library using Boost 1.32
| |
| +-+cmd (DIR)
| | +-+ai (DIR)
| | | +--libai (LIBRARY)
| | | |
| | | +--libaiserver (LIBRARY)
| | |
| | +--collide (DIR)
| | |
| | +--script (DIR)
| | |
| | +--testcollection (DIR)
| | | A set of regression tests. Should be updated to build and run when make test is executed.
| | |
| | +--libcmd (LIBRARY)
| | | (???)
| | |
| | +--libcmdserver (LIBRARY)
| | (???)
| |
| +-+common (DIR)
| | +--libcommon (LIBRARY)
| | Functions to assist with finding data directory under UNIX-like OSes
| |
| +-+gfx (DIR)
| | +-+nav (DIR)
| | | +--libnav (LIBRARY)
| | |
| | +--libgfx (LIBRARY)
| | | (???)
| | |
| | +--libgfxserver (LIBRARY)
| | (???)
| |
| +-+gldrv (DIR)
| | +--libgldrv (LIBRARY)
| | |
| | +--libgldrvserver (LIBRARY)
| |
| +-+gui (DIR)
| | +--libgui (LIBRARY)
| |
| +-+mission (DIR)
| | (BUILD BROKEN. Slated for removal if no one speaks up)
| |
| +-+networking (DIR)
| | +-+lowlevel (DIR)
| | | +--libnetlowlevel (LIBRARY)
| | |
| | +--libnet (LIBRARY)
| | |
| | +--libnetclient (LIBRARY)
| | |
| | +--libnetserver (LIBRARY)
| | |
| | +--libnetacct (LIBRARY)
| | |
| | +--soundserver (EXECUTABLE)
| | The soundserver is just a stub unless all dependencies are met.
| | RE: klauss klauss@users.sourceforge.net
| | DEP: SDL (Optional)
| | DEP: SDL_Mixer (Optional)
| |
| +-+python (DIR)
| | +--libpython (LIBRARY)
| | |
| | +--libpythonserver (LIBRARY)
| |
| +--vegastrike (EXECUTABLE)
| |
| +--vegaserver (EXECUTABLE)
| |
| +--accountserver (EXECUTABLE)
|
+-+tools (DIR)
| +--vsrmake (EXECUTABLE)
| | (???)
| |
| +--vsrextract (EXECUTABLE)
| (???)
|
|--vc98
| Contains project files for Microsoft Visual C++ 98.
|
|--VegaStrikeOSXApp.pbproj
(???)

[[Category:Development|Dependencies]]

Development:Code style

2021-06-04T14:12:02Z

Temporalbeing:

== Writing Pretty Code ==

First off, you can avoid a lot of formatting issues with your code if you run it through [http://invisible-island.net/bcpp/bcpp.html bcpp]. This is a formatter that will give you something that fixes your brace placement and indentation (for the most part). Always proof read the output. Make sure preprocessor macros start at the beginning of the line.

Second, the linux kernel code guidelines are a good place to start. [http://www.linuxjournal.com/article/5780 lk code style]. Wrapping your code to 80 lines is optional, use what makes the code clear to read.

for both headers and cpp's, make sure you have an endline at the end of the file. Please, don't edit in notepad, it makes crappy dos endlines. Use wordpad or better if in windows land.

The following guidelines are in addition to the kernel code style guidelines.

'''Headers'''

* Headers really shouldn't contain any code unless it is inline.
* Headers should try and limit the amount of forward definitions used. It's usually a sign of api corruption to have a list of more than a couple forward declarations.
* Only include the headers you need for that specific header to compile. Don't include headers your cpp file needs but header doesn't.
* When using objects from a different namespace, never "using" that namespace in the header. reference such objects fully.
* Avoid the multiple uses of "private" and "public" keywords when declaring a large class.
* Fully document your headers, defining valid / invalid arguments
* make static variables part of the class that uses them whenever possible

'''Source (cpp files)'''

* Always include system headers before project headers.
* Never put header includes after a "using namespace" directive.
* Include only the headers you need.
* Try to only use "using namespace " to use a specific class when it makes sense.
* Comments should be in headers, but in pieces of complex code (algos and weird loops/constructs) comments are required. Do not comment functions, that should be done in headers, unless the function doesn't exist in the header.

'''Classes'''

* Make as much of the class as private as possible.
* Only structs should really allow direct access to elements in the class.
* Classes are default private, so it's ok to skip the private keyword when it comes first.
* Classes should be complete. equal operators must be defined. If it makes sense someone might do arithmetic with your class, those should be handled as well. (vectors, points, etc)
* Inherit only when absolutely necessary. Never do multiple inheritance.
* Use inline functions only for very small functions (in some cases, it's acceptable on high frequency code paths).
* Use const returns and functions whenever possible. This is important.
* Try to not allow direct pointer access to elements whenever possible.
* IMPORTANT!! Make sure your class is a represents a single object/thing. Don't make it another Unit

'''Functions'''

* We have an Error class. Use it.
* Always return errors when appropriate. Do not make it the responsibility of some caller to guess your error if your function can error in more than one way.
* Keep Functions as small as possible. Avoid multiple empty lines. Keep to the rule, one purpose per function.
* Reuse temp variables when possible.
* Always initialize variables if they can be used prior to initialization. Do not rely on OS specific behavior.
* When dealing with conditionals, place exit conditionals first, then the most common case conditionals next.
* Be aware of the cost of your function in cpu time. Even if it's not in a fast-code path.

'''Structural'''

* Always include braces to denote blocks in C/C++. Many bugs come about because the braces were skipped for an initially single line block, that was then added to.
* Be explicit, not implicit. Don't rely on assumptions that may unknowingly break because the assumption changed.

----
These are guidelines written by safemode. Feel free to annotate or alter them where needed. They are not yet set in stone as no official guideline has been ratified by project leaders.

Development:Code style

2021-06-04T14:10:17Z

Temporalbeing:

== Writing Pretty Code ==

First off, you can avoid a lot of formatting issues with your code if you run it through [http://invisible-island.net/bcpp/bcpp.html bcpp]. This is a formatter that will give you something that fixes your brace placement and indentation (for the most part). Always proof read the output. Make sure preprocessor macros start at the beginning of the line.

Second, the linux kernel code guidelines are a good place to start. [http://www.linuxjournal.com/article/5780 lk code style]. Wrapping your code to 80 lines is optional, use what makes the code clear to read.

for both headers and cpp's, make sure you have an endline at the end of the file. Please, don't edit in notepad, it makes crappy dos endlines. Use wordpad or better if in windows land.

The following guidelines are in addition to the kernel code style guidelines.

'''Headers'''

* Headers really shouldn't contain any code unless it is inline.
* Headers should try and limit the amount of forward definitions used. It's usually a sign of api corruption to have a list of more than a couple forward declarations.
* Only include the headers you need for that specific header to compile. Don't include headers your cpp file needs but header doesn't.
* When using objects from a different namespace, never "using" that namespace in the header. reference such objects fully.
* Avoid the multiple uses of "private" and "public" keywords when declaring a large class.
* Fully document your headers, defining valid / invalid arguments
* make static variables part of the class that uses them whenever possible

'''Source (cpp files)'''

* Always include system headers before project headers.
* Never put header includes after a "using namespace" directive.
* Include only the headers you need.
* Try to only use "using namespace " to use a specific class when it makes sense.
* Comments should be in headers, but in pieces of complex code (algos and weird loops/constructs) comments are required. Do not comment functions, that should be done in headers, unless the function doesn't exist in the header.

'''Classes'''

* Make as much of the class as private as possible.
* Only structs should really allow direct access to elements in the class.
* Classes are default private, so it's ok to skip the private keyword when it comes first.
* Classes should be complete. equal operators must be defined. If it makes sense someone might do arithmetic with your class, those should be handled as well. (vectors, points, etc)
* Inherit only when absolutely necessary. Never do multiple inheritance.
* Use inline functions only for very small functions (in some cases, it's acceptable on high frequency code paths).
* Use const returns and functions whenever possible. This is important.
* Try to not allow direct pointer access to elements whenever possible.
* IMPORTANT!! Make sure your class is a represents a single object/thing. Don't make it another Unit

'''Functions'''

* We have an Error class. Use it.
* Always return errors when appropriate. Do not make it the responsibility of some caller to guess your error if your function can error in more than one way.
* Keep Functions as small as possible. Avoid multiple empty lines. Keep to the rule, one purpose per function.
* Reuse temp variables when possible.
* Always initialize variables if they can be used prior to initialization. Do not rely on OS specific behavior.
* When dealing with conditionals, place exit conditionals first, then the most common case conditionals next.
* Be aware of the cost of your function in cpu time. Even if it's not in a fast-code path.

'''Structural'''

* Always include braces to denote blocks in C/C++

----
These are guidelines written by safemode. Feel free to annotate or alter them where needed. They are not yet set in stone as no official guideline has been ratified by project leaders.

Vegastrike

2021-05-27T05:20:21Z

Temporalbeing:

{{Languages|En|Vegastrike}}
{{Wiki_Nav_Index}}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956; border-style:solid;border-width:1px;padding:5px;width:100%;"
|- valign="top"
|colspan="2"|
<center>'''Welcome to the Vega Strike Wiki'''</center>

Welcome to the '''Vega Strike''' [[wikipedia:Wiki|Wiki]], a user-edited manual and development guide for users and developers of the [http://www.opensource.org/ open source] '''Vega Strike''' game. Feel free to edit or add any pages you feel are necessary, but please read the [[VsWiki:Manual of Style|Manual of Style]] first, and please only add data to the [[Database]] that originates from an authoritative source.
|- valign="top"
|style="background:#ffdead;" width="50%"|<center>'''[[Manual|Player's Planet]]'''</center>
|style="background:#afa8ee;" width="50%"|<center>'''[[Development|Contributor's Station]]'''</center>
|-
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>'''Everything you wanted to know about Vega Strike''' (playing/story/etc)</center>
{|class="mainpagetable" style="color:#493956;"
|https://forums.vega-strike.org/cpg/albums/wiki_manual/cleaned3_shot_016_01_A5.png
|
* [[Manual]] - The complete game manual.
* [[Manual:New users|Information for new users]]
* [[Story Elements]]
* [[FAQ]]s - Frequently asked questions
* [[OOG Tools|Out of Game Tools]] - map viewers, route finders, etc.
* [[Database]] - Info on the Vega Strike Universe
* [[MODs|Full list of Mods]] for the Vega Strike Engine
|}
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>'''Feel free to help with the development of Vega Strike. The links below are a good starting point to do so.'''
</center>
'''''Want to contribute but don't know where to start'''''
* [[HowTo:Contribute|The Vega Strike Contributor's Guide]]
* [[Development]] & [[HowTos]] - Miscellaneous information for contributors
'''''For Artists and Modders'''''
* [[Development#Artistic_Contribution|Artists Guidelines]] - 3d models, space scapes, planet and station backgrounds, ...
* [[Development#Data_Modding|Modding Guidelines]] - config variables, missions, quests, modding tools, ...
* [[Artstyle_guides|Art Style Guides]] - VS universe style information for artists
'''''Engine References'''''
* [[DOCs]] - Engine documentation
'''''For Coders'''''
* [[Development#Code-related_Development|Coding Guidelines]] - dependencies, svn layout, code style, network protocol, ...
'''''Administrative'''''
* [[Vegastrike:Project|Project]] - Project information page
* [[Development:Roadmap|Roadmap]] - Vega Strike development plan
* [[Development#Status.2Ftask_list_pages|Status & Task List pages]]
* [[FAQ:Feature_Requests|Feature Requests]] - Ask, and you will have asked.
'''''Other'''''
* [[FAQ]]s - Frequently asked questions
* [[HowTos#Sourcecode HowTos|Sourcecode HowTos]] - Getting and installing the latest unstable version.
* [http://svn.code.sf.net/p/vegastrike/code/ Browse the SVN repository]

|}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956;border-style:solid;border-width:1px;padding:5px;width:100%;"
|- valign="top"
|colspan="2"|<center>'''The Vega Strike Community'''
If you want to help out with the wiki, or get help that this wiki cannot provide, check out the links below.
</center>
|-
|style="background:#7dcf7d;" width="50%"|<center>'''Wiki Trading Post'''</center>
|style="background:#ae6e9f;" width="50%"|<center>'''Help Shipyard'''</center>
|-
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|
* [[VsWiki:Manual of Style|Manual of Style]] - Please read it before editing, and please make any testing of the wiki system in the [[SandBox|Sandbox]].
*[http://forums.vega-strike.org/viewtopic.php?f=21&t=13186 Village Pump] - Make any discussions you wish about better organizing the wiki, or adding major new additions to the wiki.
* [[VsWiki:Requested Articles|Article Requests]] - Needed/wanted pages
* [[Wikipedia:How to edit a page|How to edit a wiki page]]
* [[:Category:Pages_needing_attention|Pages that need attention]]
* [[Special:Listusers|User list]] | [[Special:Popularpages|Most popular pages]]

* More special pages are here [[Special:Specialpages]]
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>Do you need help? Then try the forums, the main source for development or help! Or you can leave the site by any one of a number of other links...
</center>
* [http://forums.vega-strike.org Vega Strike Forums]
* [https://gitter.im/vegastrike/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link Vega Strike Gitter]

NOTE: Devs are mostly active on Gitter now.

* [[Links]]
* irc.libera.chat #vegastrike (Primary channel)
** irc://irc.libera.chat/#vegastrike
** irc://irc.libera.chat/vegastrike (link for mIRC user)

* irc.freenode.net #vegastrike (Backup channel)
** irc://irc.freenode.net/#vegastrike
** irc://irc.freenode.net/vegastrike (link for mIRC user)

Recommended open-source multi-protocol clients (IRC, ICQ/AIM, Jabber, Y!M, ...):
* Linux: [http://kopete.kde.org/ Kopete]
* Windows: [http://ayttm.sourceforge.net/ Ayttm]
* Mac: [http://fire.sourceforge.net/ Fire]
* Multi-platform: [https://pidgin.im/ Pigdin], [https://matrix.org/clients/ Matrix.org]

NOTE: Users may be interested in matrix.org as it can bridge between the networks easier.

|}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956;border-style:solid;border-width:1px;padding:5px;width:100%;"
|valign="top" |<center>'''Creating a wiki account'''
If you want to create an account in the wiki, you need to '''go to the [http://forums.vegastrike.org forum] and create an account there'''. This is because the logins are linked and creation is only possible there.
</center>
|}

----
Please see [http://meta.wikipedia.org/wiki/MediaWiki_i18n documentation on customizing the interface]
and the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for usage and configuration help.

Vegastrike

2021-05-27T05:19:44Z

Temporalbeing:

{{Languages|En|Vegastrike}}
{{Wiki_Nav_Index}}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956; border-style:solid;border-width:1px;padding:5px;width:100%;"
|- valign="top"
|colspan="2"|
<center>'''Welcome to the Vega Strike Wiki'''</center>

Welcome to the '''Vega Strike''' [[wikipedia:Wiki|Wiki]], a user-edited manual and development guide for users and developers of the [http://www.opensource.org/ open source] '''Vega Strike''' game. Feel free to edit or add any pages you feel are necessary, but please read the [[VsWiki:Manual of Style|Manual of Style]] first, and please only add data to the [[Database]] that originates from an authoritative source.
|- valign="top"
|style="background:#ffdead;" width="50%"|<center>'''[[Manual|Player's Planet]]'''</center>
|style="background:#afa8ee;" width="50%"|<center>'''[[Development|Contributor's Station]]'''</center>
|-
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>'''Everything you wanted to know about Vega Strike''' (playing/story/etc)</center>
{|class="mainpagetable" style="color:#493956;"
|https://forums.vega-strike.org/cpg/albums/wiki_manual/cleaned3_shot_016_01_A5.png
|
* [[Manual]] - The complete game manual.
* [[Manual:New users|Information for new users]]
* [[Story Elements]]
* [[FAQ]]s - Frequently asked questions
* [[OOG Tools|Out of Game Tools]] - map viewers, route finders, etc.
* [[Database]] - Info on the Vega Strike Universe
* [[MODs|Full list of Mods]] for the Vega Strike Engine
|}
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>'''Feel free to help with the development of Vega Strike. The links below are a good starting point to do so.'''
</center>
'''''Want to contribute but don't know where to start'''''
* [[HowTo:Contribute|The Vega Strike Contributor's Guide]]
* [[Development]] & [[HowTos]] - Miscellaneous information for contributors
'''''For Artists and Modders'''''
* [[Development#Artistic_Contribution|Artists Guidelines]] - 3d models, space scapes, planet and station backgrounds, ...
* [[Development#Data_Modding|Modding Guidelines]] - config variables, missions, quests, modding tools, ...
* [[Artstyle_guides|Art Style Guides]] - VS universe style information for artists
'''''Engine References'''''
* [[DOCs]] - Engine documentation
'''''For Coders'''''
* [[Development#Code-related_Development|Coding Guidelines]] - dependencies, svn layout, code style, network protocol, ...
'''''Administrative'''''
* [[Vegastrike:Project|Project]] - Project information page
* [[Development:Roadmap|Roadmap]] - Vega Strike development plan
* [[Development#Status.2Ftask_list_pages|Status & Task List pages]]
* [[FAQ:Feature_Requests|Feature Requests]] - Ask, and you will have asked.
'''''Other'''''
* [[FAQ]]s - Frequently asked questions
* [[HowTos#Sourcecode HowTos|Sourcecode HowTos]] - Getting and installing the latest unstable version.
* [http://svn.code.sf.net/p/vegastrike/code/ Browse the SVN repository]

|}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956;border-style:solid;border-width:1px;padding:5px;width:100%;"
|- valign="top"
|colspan="2"|<center>'''The Vega Strike Community'''
If you want to help out with the wiki, or get help that this wiki cannot provide, check out the links below.
</center>
|-
|style="background:#7dcf7d;" width="50%"|<center>'''Wiki Trading Post'''</center>
|style="background:#ae6e9f;" width="50%"|<center>'''Help Shipyard'''</center>
|-
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|
* [[VsWiki:Manual of Style|Manual of Style]] - Please read it before editing, and please make any testing of the wiki system in the [[SandBox|Sandbox]].
*[http://forums.vega-strike.org/viewtopic.php?f=21&t=13186 Village Pump] - Make any discussions you wish about better organizing the wiki, or adding major new additions to the wiki.
* [[VsWiki:Requested Articles|Article Requests]] - Needed/wanted pages
* [[Wikipedia:How to edit a page|How to edit a wiki page]]
* [[:Category:Pages_needing_attention|Pages that need attention]]
* [[Special:Listusers|User list]] | [[Special:Popularpages|Most popular pages]]

* More special pages are here [[Special:Specialpages]]
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>Do you need help? Then try the forums, the main source for development or help! Or you can leave the site by any one of a number of other links...
</center>
* [http://forums.vega-strike.org Vega Strike Forums]
* [https://gitter.im/vegastrike/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link Vega Strike Gitter]

NOTE: Devs are mostly active on Gitter now.

* [[Links]]
* irc.libera.net #vegastrike (Primary channel)
** irc://irc.libera.net/#vegastrike
** irc://irc.libera.net/vegastrike (link for mIRC user)

* irc.freenode.net #vegastrike (Backup channel)
** irc://irc.freenode.net/#vegastrike
** irc://irc.freenode.net/vegastrike (link for mIRC user)

Recommended open-source multi-protocol clients (IRC, ICQ/AIM, Jabber, Y!M, ...):
* Linux: [http://kopete.kde.org/ Kopete]
* Windows: [http://ayttm.sourceforge.net/ Ayttm]
* Mac: [http://fire.sourceforge.net/ Fire]
* Multi-platform: [https://pidgin.im/ Pigdin], [https://matrix.org/clients/ Matrix.org]

NOTE: Users may be interested in matrix.org as it can bridge between the networks easier.

|}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956;border-style:solid;border-width:1px;padding:5px;width:100%;"
|valign="top" |<center>'''Creating a wiki account'''
If you want to create an account in the wiki, you need to '''go to the [http://forums.vegastrike.org forum] and create an account there'''. This is because the logins are linked and creation is only possible there.
</center>
|}

----
Please see [http://meta.wikipedia.org/wiki/MediaWiki_i18n documentation on customizing the interface]
and the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for usage and configuration help.

Vegastrike

2021-05-27T05:19:10Z

Temporalbeing: FreeNode IRC is now secondary; primary is Libera.chat

{{Languages|En|Vegastrike}}
{{Wiki_Nav_Index}}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956; border-style:solid;border-width:1px;padding:5px;width:100%;"
|- valign="top"
|colspan="2"|
<center>'''Welcome to the Vega Strike Wiki'''</center>

Welcome to the '''Vega Strike''' [[wikipedia:Wiki|Wiki]], a user-edited manual and development guide for users and developers of the [http://www.opensource.org/ open source] '''Vega Strike''' game. Feel free to edit or add any pages you feel are necessary, but please read the [[VsWiki:Manual of Style|Manual of Style]] first, and please only add data to the [[Database]] that originates from an authoritative source.
|- valign="top"
|style="background:#ffdead;" width="50%"|<center>'''[[Manual|Player's Planet]]'''</center>
|style="background:#afa8ee;" width="50%"|<center>'''[[Development|Contributor's Station]]'''</center>
|-
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>'''Everything you wanted to know about Vega Strike''' (playing/story/etc)</center>
{|class="mainpagetable" style="color:#493956;"
|https://forums.vega-strike.org/cpg/albums/wiki_manual/cleaned3_shot_016_01_A5.png
|
* [[Manual]] - The complete game manual.
* [[Manual:New users|Information for new users]]
* [[Story Elements]]
* [[FAQ]]s - Frequently asked questions
* [[OOG Tools|Out of Game Tools]] - map viewers, route finders, etc.
* [[Database]] - Info on the Vega Strike Universe
* [[MODs|Full list of Mods]] for the Vega Strike Engine
|}
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>'''Feel free to help with the development of Vega Strike. The links below are a good starting point to do so.'''
</center>
'''''Want to contribute but don't know where to start'''''
* [[HowTo:Contribute|The Vega Strike Contributor's Guide]]
* [[Development]] & [[HowTos]] - Miscellaneous information for contributors
'''''For Artists and Modders'''''
* [[Development#Artistic_Contribution|Artists Guidelines]] - 3d models, space scapes, planet and station backgrounds, ...
* [[Development#Data_Modding|Modding Guidelines]] - config variables, missions, quests, modding tools, ...
* [[Artstyle_guides|Art Style Guides]] - VS universe style information for artists
'''''Engine References'''''
* [[DOCs]] - Engine documentation
'''''For Coders'''''
* [[Development#Code-related_Development|Coding Guidelines]] - dependencies, svn layout, code style, network protocol, ...
'''''Administrative'''''
* [[Vegastrike:Project|Project]] - Project information page
* [[Development:Roadmap|Roadmap]] - Vega Strike development plan
* [[Development#Status.2Ftask_list_pages|Status & Task List pages]]
* [[FAQ:Feature_Requests|Feature Requests]] - Ask, and you will have asked.
'''''Other'''''
* [[FAQ]]s - Frequently asked questions
* [[HowTos#Sourcecode HowTos|Sourcecode HowTos]] - Getting and installing the latest unstable version.
* [http://svn.code.sf.net/p/vegastrike/code/ Browse the SVN repository]

|}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956;border-style:solid;border-width:1px;padding:5px;width:100%;"
|- valign="top"
|colspan="2"|<center>'''The Vega Strike Community'''
If you want to help out with the wiki, or get help that this wiki cannot provide, check out the links below.
</center>
|-
|style="background:#7dcf7d;" width="50%"|<center>'''Wiki Trading Post'''</center>
|style="background:#ae6e9f;" width="50%"|<center>'''Help Shipyard'''</center>
|-
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|
* [[VsWiki:Manual of Style|Manual of Style]] - Please read it before editing, and please make any testing of the wiki system in the [[SandBox|Sandbox]].
*[http://forums.vega-strike.org/viewtopic.php?f=21&t=13186 Village Pump] - Make any discussions you wish about better organizing the wiki, or adding major new additions to the wiki.
* [[VsWiki:Requested Articles|Article Requests]] - Needed/wanted pages
* [[Wikipedia:How to edit a page|How to edit a wiki page]]
* [[:Category:Pages_needing_attention|Pages that need attention]]
* [[Special:Listusers|User list]] | [[Special:Popularpages|Most popular pages]]

* More special pages are here [[Special:Specialpages]]
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>Do you need help? Then try the forums, the main source for development or help! Or you can leave the site by any one of a number of other links...
</center>
* [http://forums.vega-strike.org Vega Strike Forums]
* [https://gitter.im/vegastrike/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link Vega Strike Gitter]

NOTE: Devs are mostly active on Gitter now.

NOTE: We are moving our primary IRC from FreeNode to Libera after the recent issues with FreeNode. Information below will be updated once the Libera.chat channel is in place.

* [[Links]]
* irc.libera.net #vegastrike (Primary channel)
** irc://irc.libera.net/#vegastrike
** irc://irc.libera.net/vegastrike (link for mIRC user)

* irc.freenode.net #vegastrike (Backup channel)
** irc://irc.freenode.net/#vegastrike
** irc://irc.freenode.net/vegastrike (link for mIRC user)

Recommended open-source multi-protocol clients (IRC, ICQ/AIM, Jabber, Y!M, ...):
* Linux: [http://kopete.kde.org/ Kopete]
* Windows: [http://ayttm.sourceforge.net/ Ayttm]
* Mac: [http://fire.sourceforge.net/ Fire]
* Multi-platform: [https://pidgin.im/ Pigdin], [https://matrix.org/clients/ Matrix.org]

NOTE: Users may be interested in matrix.org as it can bridge between the networks easier.

|}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956;border-style:solid;border-width:1px;padding:5px;width:100%;"
|valign="top" |<center>'''Creating a wiki account'''
If you want to create an account in the wiki, you need to '''go to the [http://forums.vegastrike.org forum] and create an account there'''. This is because the logins are linked and creation is only possible there.
</center>
|}

----
Please see [http://meta.wikipedia.org/wiki/MediaWiki_i18n documentation on customizing the interface]
and the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for usage and configuration help.

Vegastrike

2021-05-27T04:54:27Z

Temporalbeing: Announcement of Libera.chat move

{{Languages|En|Vegastrike}}
{{Wiki_Nav_Index}}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956; border-style:solid;border-width:1px;padding:5px;width:100%;"
|- valign="top"
|colspan="2"|
<center>'''Welcome to the Vega Strike Wiki'''</center>

Welcome to the '''Vega Strike''' [[wikipedia:Wiki|Wiki]], a user-edited manual and development guide for users and developers of the [http://www.opensource.org/ open source] '''Vega Strike''' game. Feel free to edit or add any pages you feel are necessary, but please read the [[VsWiki:Manual of Style|Manual of Style]] first, and please only add data to the [[Database]] that originates from an authoritative source.
|- valign="top"
|style="background:#ffdead;" width="50%"|<center>'''[[Manual|Player's Planet]]'''</center>
|style="background:#afa8ee;" width="50%"|<center>'''[[Development|Contributor's Station]]'''</center>
|-
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>'''Everything you wanted to know about Vega Strike''' (playing/story/etc)</center>
{|class="mainpagetable" style="color:#493956;"
|https://forums.vega-strike.org/cpg/albums/wiki_manual/cleaned3_shot_016_01_A5.png
|
* [[Manual]] - The complete game manual.
* [[Manual:New users|Information for new users]]
* [[Story Elements]]
* [[FAQ]]s - Frequently asked questions
* [[OOG Tools|Out of Game Tools]] - map viewers, route finders, etc.
* [[Database]] - Info on the Vega Strike Universe
* [[MODs|Full list of Mods]] for the Vega Strike Engine
|}
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>'''Feel free to help with the development of Vega Strike. The links below are a good starting point to do so.'''
</center>
'''''Want to contribute but don't know where to start'''''
* [[HowTo:Contribute|The Vega Strike Contributor's Guide]]
* [[Development]] & [[HowTos]] - Miscellaneous information for contributors
'''''For Artists and Modders'''''
* [[Development#Artistic_Contribution|Artists Guidelines]] - 3d models, space scapes, planet and station backgrounds, ...
* [[Development#Data_Modding|Modding Guidelines]] - config variables, missions, quests, modding tools, ...
* [[Artstyle_guides|Art Style Guides]] - VS universe style information for artists
'''''Engine References'''''
* [[DOCs]] - Engine documentation
'''''For Coders'''''
* [[Development#Code-related_Development|Coding Guidelines]] - dependencies, svn layout, code style, network protocol, ...
'''''Administrative'''''
* [[Vegastrike:Project|Project]] - Project information page
* [[Development:Roadmap|Roadmap]] - Vega Strike development plan
* [[Development#Status.2Ftask_list_pages|Status & Task List pages]]
* [[FAQ:Feature_Requests|Feature Requests]] - Ask, and you will have asked.
'''''Other'''''
* [[FAQ]]s - Frequently asked questions
* [[HowTos#Sourcecode HowTos|Sourcecode HowTos]] - Getting and installing the latest unstable version.
* [http://svn.code.sf.net/p/vegastrike/code/ Browse the SVN repository]

|}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956;border-style:solid;border-width:1px;padding:5px;width:100%;"
|- valign="top"
|colspan="2"|<center>'''The Vega Strike Community'''
If you want to help out with the wiki, or get help that this wiki cannot provide, check out the links below.
</center>
|-
|style="background:#7dcf7d;" width="50%"|<center>'''Wiki Trading Post'''</center>
|style="background:#ae6e9f;" width="50%"|<center>'''Help Shipyard'''</center>
|-
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|
* [[VsWiki:Manual of Style|Manual of Style]] - Please read it before editing, and please make any testing of the wiki system in the [[SandBox|Sandbox]].
*[http://forums.vega-strike.org/viewtopic.php?f=21&t=13186 Village Pump] - Make any discussions you wish about better organizing the wiki, or adding major new additions to the wiki.
* [[VsWiki:Requested Articles|Article Requests]] - Needed/wanted pages
* [[Wikipedia:How to edit a page|How to edit a wiki page]]
* [[:Category:Pages_needing_attention|Pages that need attention]]
* [[Special:Listusers|User list]] | [[Special:Popularpages|Most popular pages]]

* More special pages are here [[Special:Specialpages]]
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>Do you need help? Then try the forums, the main source for development or help! Or you can leave the site by any one of a number of other links...
</center>
* [http://forums.vega-strike.org Vega Strike Forums]
* [https://gitter.im/vegastrike/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link Vega Strike Gitter]

NOTE: Devs are mostly active on Gitter now.

NOTE: We are moving our primary IRC from FreeNode to Libera after the recent issues with FreeNode. Information below will be updated once the Libera.chat channel is in place.

* [[Links]]
* irc.freenode.net #vegastrike (Main chanel)
** irc://irc.freenode.net/#vegastrike
** irc://irc.freenode.net/vegastrike (link for mIRC user)
* irc.stealth.net #vegastrike (Backup chanel)
** irc://irc.stealth.net/#vegastrike
** irc://irc.stealth.net/vegastrike (link for mIRC user)

Recommended open-source multi-protocol clients (IRC, ICQ/AIM, Jabber, Y!M, ...):
* Linux: [http://kopete.kde.org/ Kopete]
* Windows: [http://ayttm.sourceforge.net/ Ayttm]
* Mac: [http://fire.sourceforge.net/ Fire]

|}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956;border-style:solid;border-width:1px;padding:5px;width:100%;"
|valign="top" |<center>'''Creating a wiki account'''
If you want to create an account in the wiki, you need to '''go to the [http://forums.vegastrike.org forum] and create an account there'''. This is because the logins are linked and creation is only possible there.
</center>
|}

----
Please see [http://meta.wikipedia.org/wiki/MediaWiki_i18n documentation on customizing the interface]
and the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for usage and configuration help.

Vegastrike

2020-12-22T05:20:24Z

Temporalbeing:

{{Languages|En|Vegastrike}}
{{Wiki_Nav_Index}}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956; border-style:solid;border-width:1px;padding:5px;width:100%;"
|- valign="top"
|colspan="2"|
<center>'''Welcome to the Vega Strike Wiki'''</center>

Welcome to the '''Vega Strike''' [[wikipedia:Wiki|Wiki]], a user-edited manual and development guide for users and developers of the [http://www.opensource.org/ open source] '''Vega Strike''' game. Feel free to edit or add any pages you feel are necessary, but please read the [[VsWiki:Manual of Style|Manual of Style]] first, and please only add data to the [[Database]] that originates from an authoritative source.
|- valign="top"
|style="background:#ffdead;" width="50%"|<center>'''[[Manual|Player's Planet]]'''</center>
|style="background:#afa8ee;" width="50%"|<center>'''[[Development|Contributor's Station]]'''</center>
|-
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>'''Everything you wanted to know about Vega Strike''' (playing/story/etc)</center>
{|class="mainpagetable" style="color:#493956;"
|https://forums.vega-strike.org/cpg/albums/wiki_manual/cleaned3_shot_016_01_A5.png
|
* [[Manual]] - The complete game manual.
* [[Manual:New users|Information for new users]]
* [[Story Elements]]
* [[FAQ]]s - Frequently asked questions
* [[OOG Tools|Out of Game Tools]] - map viewers, route finders, etc.
* [[Database]] - Info on the Vega Strike Universe
* [[MODs|Full list of Mods]] for the Vega Strike Engine
|}
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>'''Feel free to help with the development of Vega Strike. The links below are a good starting point to do so.'''
</center>
'''''Want to contribute but don't know where to start'''''
* [[HowTo:Contribute|The Vega Strike Contributor's Guide]]
* [[Development]] & [[HowTos]] - Miscellaneous information for contributors
'''''For Artists and Modders'''''
* [[Development#Artistic_Contribution|Artists Guidelines]] - 3d models, space scapes, planet and station backgrounds, ...
* [[Development#Data_Modding|Modding Guidelines]] - config variables, missions, quests, modding tools, ...
* [[Artstyle_guides|Art Style Guides]] - VS universe style information for artists
'''''Engine References'''''
* [[DOCs]] - Engine documentation
'''''For Coders'''''
* [[Development#Code-related_Development|Coding Guidelines]] - dependencies, svn layout, code style, network protocol, ...
'''''Administrative'''''
* [[Vegastrike:Project|Project]] - Project information page
* [[Development:Roadmap|Roadmap]] - Vega Strike development plan
* [[Development#Status.2Ftask_list_pages|Status & Task List pages]]
* [[FAQ:Feature_Requests|Feature Requests]] - Ask, and you will have asked.
'''''Other'''''
* [[FAQ]]s - Frequently asked questions
* [[HowTos#Sourcecode HowTos|Sourcecode HowTos]] - Getting and installing the latest unstable version.
* [http://svn.code.sf.net/p/vegastrike/code/ Browse the SVN repository]

|}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956;border-style:solid;border-width:1px;padding:5px;width:100%;"
|- valign="top"
|colspan="2"|<center>'''The Vega Strike Community'''
If you want to help out with the wiki, or get help that this wiki cannot provide, check out the links below.
</center>
|-
|style="background:#7dcf7d;" width="50%"|<center>'''Wiki Trading Post'''</center>
|style="background:#ae6e9f;" width="50%"|<center>'''Help Shipyard'''</center>
|-
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|
* [[VsWiki:Manual of Style|Manual of Style]] - Please read it before editing, and please make any testing of the wiki system in the [[SandBox|Sandbox]].
*[http://forums.vega-strike.org/viewtopic.php?f=21&t=13186 Village Pump] - Make any discussions you wish about better organizing the wiki, or adding major new additions to the wiki.
* [[VsWiki:Requested Articles|Article Requests]] - Needed/wanted pages
* [[Wikipedia:How to edit a page|How to edit a wiki page]]
* [[:Category:Pages_needing_attention|Pages that need attention]]
* [[Special:Listusers|User list]] | [[Special:Popularpages|Most popular pages]]

* More special pages are here [[Special:Specialpages]]
|valign="top" style="border-style:solid;border-width:1px;padding:5px;"|<center>Do you need help? Then try the forums, the main source for development or help! Or you can leave the site by any one of a number of other links...
</center>
* [http://forums.vega-strike.org Vega Strike Forums]
* [https://gitter.im/vegastrike/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link Vega Strike Gitter]

NOTE: Devs are mostly active on Gitter now.

* [[Links]]
* irc.freenode.net #vegastrike (Main chanel)
** irc://irc.freenode.net/#vegastrike
** irc://irc.freenode.net/vegastrike (link for mIRC user)
* irc.stealth.net #vegastrike (Backup chanel)
** irc://irc.stealth.net/#vegastrike
** irc://irc.stealth.net/vegastrike (link for mIRC user)

Recommended open-source multi-protocol clients (IRC, ICQ/AIM, Jabber, Y!M, ...):
* Linux: [http://kopete.kde.org/ Kopete]
* Windows: [http://ayttm.sourceforge.net/ Ayttm]
* Mac: [http://fire.sourceforge.net/ Fire]

|}

{| cellspacing="3" class="mainpagetable" align="center" style="color:#493956;border-style:solid;border-width:1px;padding:5px;width:100%;"
|valign="top" |<center>'''Creating a wiki account'''
If you want to create an account in the wiki, you need to '''go to the [http://forums.vegastrike.org forum] and create an account there'''. This is because the logins are linked and creation is only possible there.
</center>
|}

----
Please see [http://meta.wikipedia.org/wiki/MediaWiki_i18n documentation on customizing the interface]
and the [http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide] for usage and configuration help.