BotF2-Wiki - User contributions [en]

System Requirements

2023-02-11T12:48:18Z

Reginald:

Check your installed programs: just press Win-Key+R and input "appwiz.cpl" + ENTER.

Check:
*Microsoft .NET Framework 4.https://dotnet.microsoft.com/en-us/download/dotnet-framework - also update to latest Windows version
*Microsoft Visual C++ 2008 Redistributable (1,7 MB) (needed !)
*Microsoft Visual C++ 2010 Redistributable (5 MB) https://support.microsoft.com/de-de/help/2977003/the-latest-supported-visual-c-downloads
*Microsoft XNA Framework (7 MB)

The currently requirements are:

*'''Microsoft .NET Framework 4.6.2 Extended ([http://en.wikipedia.org/wiki/.NET_Framework Wikipedia]) -> manual installing is necessary ->''' [http://botf2.square7.ch/wiki/index.php?title=Problem#check_your_.Net-Version Check and download here]

Summary: any usual Windows PC
*Intel Core Processor (not to old)
*512mb RAM
*[[Windows]] (tm): Windows XP up to Windows 8.1 (if you have problems, just see [[Problem#Windows problem]])
*DirectX 9-compatible video card with Pixel Shader 2.0+ and Vertex Shader 1.1+ support
*Desktop resolution of at least 1024x768 (1280x768 or higher is strongly recommended)
*[[DirectX]] 9 or greater
----
Due to other programs also use the next parts the game requires (e.g. Zone Alarm free: Microsoft .NET Redistributable, Microsoft VC++ Redistributable (x86) http://www.windowsuninstaller.org/forums/viewtopic.php?f=8&t=743#p1158) some might be already installed on your PC. This might be the reason why some persons can ran Supremacy without great installing all the requirements, and others have to install all the stuff.
----
Many reports are on missing XNA. Just mention this requirement:
*Microsoft XNA Framework v3.1 Redistributable http://www.microsoft.com/en-us/download/details.aspx?id=15163
Without it, the game isn't able to load the 3d models that you can see in the shipyard, resulting in crashes.

----

If BotF2 still not runs then...

Lloyd James wrote: To run BotF2, you need ALL of the following installed:
*Microsoft .NET Framework ''4.5.1'' (note: you want the full framework, not the "Client Profile"; after it's installed, you should see both the "Client Profile" and "Extended Profile" listed in your control panel. Also note that the latest version of .Net is 4.5, and future game versions *might* need the more recent versions) http://www.microsoft.com/de-de/download/details.aspx?id=40779
*Microsoft DirectX Runtime
*Microsoft XNA Framework v3.1 Redistributable http://www.microsoft.com/en-us/download/details.aspx?id=15163, v4.0 might also work http://www.microsoft.com/en-us/download/details.aspx?id=20914
*Microsoft Visual C++ 2008 Redistributable (1,7 MB) (needed !)
*Microsoft Visual C++ 2010 Redistributable (5 MB)

All of these can be found via Google. Simply copy-and-paste them and select the first link that appears.

Category:Races

2023-01-14T14:09:47Z

Reginald:

also or better called: >>[[Civilizations]]

playable: [[Major]]s like [[Federation]] - [[Romulans]] - [[Klingons]] - [[Cardassians]] - [[Dominion]] - [[Borg]] - [[Terran Empire]]

not playable: [[Minor]]s
----
(you can check https://intl.startrek.com/database or at minor's Wiki-site there are links to [http://en.memory-alpha.org Memory Alpha])

»Ramatians

2022-11-13T11:08:55Z

Reginald:

{|class="wikitable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Race
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Image
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Insignia
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Description
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Type
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Planet

|-
|style=text-align:center|[http://en.memory-alpha.org/wiki/Ramatisian Ramatians] (indeed Ramatis III natives - unnamed species)
|style=text-align:left bgcolor="black"|<img size="150">http://botf2.square7.ch/wiki-files/images/Races/ramatians.png</img>
|style=text-align:left bgcolor="black"|<img size="100">http://botf2.square7.ch/wiki-files/images/Insignias/ramatians.png</img>
|style=text-align:left|
Many of the Ramatian people lack the gene that makes hearing possible. The ruling family have devised a method of communication involving a telepathic interpretative 'chorus' - a harmonious mental waveform that resonates with the different facets of personality, which they interpret as communicative thought patterns. Because of this skill they are able to delve deeply into the thought structures of almost any mind, perceiving thought, simplifying, amongst many cross-cultural and lingual boundaries, first contact negotiations, and mediation.

|style=text-align:center|Terran
|style=text-align:left bgcolor="black"|<img size="150">http://botf2.square7.ch/wiki-files/images/Planets/no.png</img>

|}

== Buildings ==
{|class="wikitable" width="100%"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Building
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Image
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Tech
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" width="50%"|Description
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:center|RAMATIAN_HALL_OF_MEDIATORS

|style=text-align:center bgcolor="black"|<img size="150">http://botf2.square7.ch/wiki-files/images/TechObjects/Buildings/ramatian_hall_of_mediators.png</img>
|style=text-align:center|
|style=text-align:left|
In these halls, experts in diplomacy, translation and thought melds bring disparate minds together in conciliation and understanding. The mediators are the most skilled and gifted individuals in their field.

|style=text-align:left|
http://botf2.square7.ch/b2_db/Buildings.php
|style=text-align:left|

|}

[[Category:Races]] [[Category:Building]] [[Category:Ships]]

Galaxy Panel

2022-09-24T13:47:52Z

Reginald: /* Other Maps */

== Intro ==
[[category:GUI]]

*>> see also [[Manual#Galaxy Panel]]

<img size=957>http://botf2.square7.ch/wiki-files/images/_Screenshots/1---Galaxy/1---GalaxyPanel_Described.jpg</img>

== Territory ==

*https://bitbucket.org/mstrobel/supremacy/issue/317/disputed-territory (issue/317)

== Other Maps ==

* Coordinates https://memory-alpha.fandom.com/wiki/Coordinates

* https://memory-alpha.fandom.com/wiki/Map:The_explored_galaxy

* https://sp1np0rtal.github.io/stfc-galaxy-map/

Galaxy Panel

2022-09-17T12:22:18Z

Reginald: /* Other Maps */

== Intro ==
[[category:GUI]]

*>> see also [[Manual#Galaxy Panel]]

<img size=957>http://botf2.square7.ch/wiki-files/images/_Screenshots/1---Galaxy/1---GalaxyPanel_Described.jpg</img>

== Territory ==

*https://bitbucket.org/mstrobel/supremacy/issue/317/disputed-territory (issue/317)

== Other Maps ==

* https://memory-alpha.fandom.com/wiki/Map:The_explored_galaxy

* https://sp1np0rtal.github.io/stfc-galaxy-map/

Galaxy Panel

2022-09-17T11:58:10Z

Reginald:

Model

2022-05-07T07:45:23Z

Reginald:

\Resources\Models are used for display at Ship Building, '''but at the moment only a few models are available (e.g. Federation Colony Ship I)'''.

>> http://botf2.square7.ch/wiki-files/Models/Models.zip

If no model is done it is shown: NO MODEL AVAILABLE. For having a look to the ship just go to [[Encyclopedia]].

*Microsoft XNA Game Studio 4.0 (free, needs Visual Studio 2010) http://www.microsoft.com/en-us/download/confirmation.aspx?id=23714

For having a look to the models you can install [http://gruaz.net/?page_id=407 GameTools], direct download [http://teapot-studio.com/products/gametools/gametools_setup.exe here].
In addition it will install XNA which also may solve some problems.

<img>http://botf2.square7.ch/wiki-files/images/GameToolsSetup.png</img>

== XNB ==

*http://pcsupport.about.com/od/fileextensions/f/xnbfile.htm

3D Model

2022-03-05T13:50:39Z

Reginald: /* Intro */

[[Category:3D Combat Engine]]
= Intro =

= How to bring in =

3D Model

2022-03-05T13:50:16Z

Reginald: Created page with "Category:3D Combat Engine = Intro ="

[[Category:3D Combat Engine]]
= Intro =

MediaWiki:Sidebar

2022-03-05T13:49:34Z

Reginald:

Borg

2021-09-26T06:20:06Z

Reginald:

__NOTOC__

== Borg ==

in 2016 we hope to make Borg playable as a major/empire race. If so, indeed there are some differences to the other empires in game mechanics:
*Borg doesn't have colony ships. To own a sector just build a station in that sector (instead of colonizing).
*if a colony is inhabitant you can assimilate it by assaulting the system. Don't forget to use transport ships, transporting borg drones for assimilation. Without that you will just bombard the colony.

Than minor race "[[»Borg|Borg]]" is thrown out of the game.

{| width="80%" bgcolor="lightgreen" style="border:2px solid #7d85e6;padding:1em;padding-top:0.5em;"

|valign="center" align="center" | <img>http://botf2.square7.ch/wiki-files/images/Civilizations/borgcollective.png</img>

| width="1%" bgcolor="#b3b8f4" |

| bgcolor="#fafafa" width="90%" - valign="top"|
"We are the Borg. You will be assimilated. Resistance is futile."

The Borg are/were a pseudo-species of cybernetic beings, or cyborgs, from the Delta Quadrant. No single individual truly existed within the Borg Collective (with the possible sole exception of the Borg Queen), as all Borg were linked into a hive mind. Their ultimate goal was the attainment of 'perfection' through the forcible assimilation of diverse sentient species, technologies, and knowledge. As a result, the Borg were among the most powerful and feared entities in the galaxy, without really being a true species at all.
The precise origins of the Borg are unclear. As of 1484 AD, they were reported as controlling only a handful of systems in the Delta Quadrant, but by 2373, they had assimilated thousands of worlds. In addition to this stronghold in the Delta Quadrant, the Borg also dispatched vessels throughout the galaxy via transwarp conduits.
The Borg Collective population is at the very least made up several trillion humanoid and non-humanoid species referred to as drones. Through the use of their cybernetic implants, the Borg interacted by sharing one another's thoughts in a hive mind. Upon assimilation, these trillions of "voices" would overwhelm the drone, stifling individual thought and resistance to the Collective's will. To some drones these voices could eventually become a source of comfort, and their absence a source of pain.

Borg philosophy was governed by a primary directive to add the biological and technological distinctiveness of other species to that of the Borg. In this manner the Collective sought to achieve its definition of perfection; all other pursuits were deemed irrelevant. Accordingly, Borg drones did not engage in any activities except their duties and regeneration. Individual drones have demonstrated puzzlement at other species' unwillingness to be assimilated, the drones believing in the superiority of their way of life.

<img>http://botf2.square7.ch/wiki-files/images/_Screenshots/1---Galaxy/Systems/BorgCollective.png</img>

|-
|bgcolor="lightgreen" align="middle" | <img size=120>http://botf2.square7.ch/wiki-files/images/Insignias/BORGCOLLECTIVE.png</img>
|
| bgcolor="#fafafa" |

*Civilization Key="BORG"

*Race: '''BORGCOLLECTIVE'''
*ShortName: '''Borg'''
*LongName: '''Borg Collective'''

*HomeSystem: '''borg collective'''

*Color: '''Blue'''
*HomeQuadrant: '''Alpha'''
*CivilizationType: '''Empire'''
*TechCurve: '''TechCurve6'''

|-
|bgcolor="lightgreen" align="middle" | <img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/ProductionFacilities/borg_alcove.png</img> 

<img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/ProductionFacilities/borg_nanobot_factory_SMALL.png</img> 

<img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/ProductionFacilities/borg_process_node_SMALL.png</img> 
|
| bgcolor="#fafafa" |

<img>http://botf2.square7.ch/wiki-files/images/_Screenshots/2-2-System-Structures/2-2-System-Borg-SomeStructures.jpg</img>
|}

== Ships ==

see >> [[»Borg|Borg]]

*http://memory-alpha.wikia.com/wiki/Borg_starships

== Playing Borg ==

Playing Borg is hard balanced between being a hostile race and having some disadvantages.

*Borg don't have colony ships so build transport ships and assault foreign systems. Don't forget to declare war before to that race using [[Embassy]] screen.
*Borg ships are quite strong in ship-to-ship-combat (advantage)
*[[Moon Habitation]] (or in real building Complexes) is a strong advantage getting a lot of borg drones. Hopefully your starting system "borg nebula" has one or more moons as well.
*

=== Starting Tech Level EARLY ===

*for ship building you need to build some energy reactors first and save energy as far as you can (turn off Shield Generator)

=== Starting Tech Level SUPREME ===

[[Category:Races]]

Cardassians

2021-09-26T06:14:24Z

Reginald: /* Cardassian Union */

== Cardassian Union ==
{| width="80%" bgcolor="grey" style="border:2px solid DarkGoldenrod;padding:1em;padding-top:0.5em;"

|valign="top" align="center" | <img>http://botf2.square7.ch/wiki-files/images/Civilizations/cardassians.png</img>

| width="1%" |

| bgcolor="#fafafa" width="90%" - valign="top"|
The Cardassians use any means necessary to ensure the absolute loyalty of their subjects. A national indoctrination, mixed with effective control methods, promotes an unconditional belief in the Cardassian systems and work ethics, which results in exceptional industrial and mining capacity. These state-promoted plants clearly work far more effectively than their food and energy installations however, and their research advances at a slow rate. Their intelligence services, the Obsidian Order, are also very efficient, and are considered to be as dangerous as their military, both in the acts of espionage and sabotage. Cardassian ships continue the principle of community-controlled actions in space. Individually not very efficient, they are developed to attack in tight formations.

<img>http://botf2.square7.ch/wiki-files/images/_Screenshots/1---Galaxy/Systems/Cardassia.png</img>

|-
| align="middle" | <img size=120>http://botf2.square7.ch/wiki-files/images/Insignias/cardassians.png</img>
|
| bgcolor="#fafafa" |
*Race: '''CARDASSIANS'''
*ShortName: '''Cardassians'''
*LongName: '''Cardassian Union'''

*HomeSystem: '''Cardassia''' (pop: 305, growth: 3,6%): (3) Cardassia Prime
*Color: '''DarkGoldenrod'''
*HomeQuadrant: '''Alpha'''
*CivilizationType: '''Empire'''
*TechCurve: '''TechCurve6'''

|-
| align="middle" | <img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/Buildings/card_detapa_council.png</img> Detapa Council

<img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/Buildings/card_the_obsidian_order.png</img> The Obsidian Order

<img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/Buildings/card_forced_labour_farms.png</img> Forced-Labour Farms
|
| bgcolor="#fafafa" |
"The Cardassians are a humanoid species from the Alpha Quadrant. They are native to the planet Cardassia Prime, capital world of the Cardassian Union, and are ruled by an oppressive military dictatorship. However, in its ancient history, before Cardassia was ruled by the military, the Cardassian people were known as the Hebitians, a society known for their fine art and beautiful architecture. But the Hebitian civilization was wasteful, and fell into decay from a chronic lack of natural resources; millions of Hebitians starved to death. The planet was subjected to decades of utter anarchy, eventually resulting in the extinction of Hebitian society.

In a last attempt at survival, the few remaining Hebitians turned to the military to solve their problems, who quickly developed efficient new spacefaring technologies to allow resources to be acquired from distant planets and systems. Renaming themselves the Cardassian Union, the Cardassians quickly came to be a military power in their own right, brutally, but efficiently, subjugating entire systems in their unquenchable thirst for natural resources.

To this day, the Cardassians are ruled by an oppressive military government where efficiency and absolute loyalty are the only things that matter."

<img>http://botf2.square7.ch/wiki-files/images/_Screenshots/2-2-System-Structures/2-2-System-Cardassia-SomeStructures.jpg</img>
|}

[[Category:Races]]

Klingons

2021-09-26T06:13:51Z

Reginald: /* Klingon Empire */

== Klingon Empire ==
{| width="80%" bgcolor="Crimson" style="border:2px solid red;padding:1em;padding-top:0.5em;"

|valign="top" align="center" | <img>http://botf2.square7.ch/wiki-files/images/Civilizations/klingons.png</img>

| width="1%" |

| bgcolor="#fafafa" width="90%" - valign="top"|
The Klingons are some of the most feared warriors in the galaxy. Their quest for glory and honour in battle makes them masters in the field of combat; be it in ground or space-based combat, their weapons arm quickly and strike hard. Some of their battleships possess cloaking devices, with which the Klingons strike from the shadows at their prey. Their vigorous industrial forges process countless masses of raw materials, keeping their resource-hungry war machine running, whilst gigantic hunting parties guarantee the population's food supply. However, all things that do not directly serve battle are of lower importance to them and thus are less effective. The Klingons consider espionage a cowardly and dishonourable act, but are willing to defend themselves through internal security as necessary.

<img>http://botf2.square7.ch/wiki-files/images/_Screenshots/1---Galaxy/Systems/QonoS.png</img>

|-
| align="middle" | <img size=120>http://botf2.square7.ch/wiki-files/images/Insignias/klingons.png</img>
|
| bgcolor="#fafafa" |
*Race: '''KLINGONS'''
*ShortName: '''Klingons'''
*LongName: '''Klingon Empire'''

*HomeSystem: '''Qo'noS''' (pop: 305, growth: 3,5%)
*Color: '''Crimson'''
*HomeQuadrant: '''Beta'''
*CivilizationType: '''Empire'''
*TechCurve: '''TechCurve6'''

|-
| align="middle" | <img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/Buildings/kling_great_hall.png</img> Great Hall

<img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/Buildings/kling_hall_of_warriors.png</img> Hall of Warriors
|
| bgcolor="#fafafa" |
The Klingons (Klingonese: tlhIngan) are a humanoid warrior species that originates from the jungle planet Qo'noS (pronounced Kronos). One of the major powers of the galaxy, the Klingons are a proud, tradition-bound people who value honour and combat. The aggressive Klingon culture has made them an interstellar military power that is to be respected and feared. Klingons believe that they have the instinctive ability to look an opponent in the eye and see the intent to kill. Those that have such intent rarely get the chance to do so - unless they are another Klingon.

<img>http://botf2.square7.ch/wiki-files/images/_Screenshots/2-2-System-Structures/2-2-System-QonoS-SomeStructures.jpg</img>
|}

Not part of BotF2:
*Klingon War Song http://www.youtube.com/watch?v=WBZ2MEBTYJs
*Klingon Drinking Song http://www.youtube.com/watch?v=cTuD6xf-ync

[[Category:Races]]

Romulans

2021-09-26T06:13:07Z

Reginald:

== Romulan Star Empire ==
{| width="90%" bgcolor="#efffec" style="border:2px solid green;padding:1em;padding-top:0.5em;"

|valign="top" align="center" valign="center" | <img size=275>http://botf2.square7.ch/wiki-files/images/Civilizations/romulans.png</img>

| width="1%" |

| bgcolor="#fafafa" width="80%" - valign="top"|
To outsiders, the Romulans are an enigmatic race. To the Romulans, however, other races have hardly any mystery left, for their talented intelligence agency, the Tal Shiar, has solved each of those mysteries. Romulan interests are protected by a veil of secrecy and covertness, just as their ships are hidden from prying eyes by powerful cloaking technologies. Their ships move undetected in groups until they are close to their unsuspecting victim, before decloaking and destroying their target in the ambush. Reports on Romulan society show it functions on exceptional research achievements; their industry and mining efforts are not quite as effective, however. The basic supply of energy and food for the populace is sufficient to meet day-to-day needs, and is rigorously regulated to be resource-saving, as are their fleet maintenance costs; Romulan fleets expect to decimate the enemy before they have any chance at mounting a defence. There is therefore little need to equip their vessels with expensive armour plating. This should not be seen as a weakness however; Romulan ships are known equally for their manoeuverability and heavy weapons, and for their ability to disappear at will.

<img>http://botf2.square7.ch/wiki-files/images/_Screenshots/1---Galaxy/Systems/Romulus.png</img>
----
|-
| align="middle" | <img size=120>http://botf2.square7.ch/wiki-files/images/Insignias/romulans.png</img> <img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/Buildings/rom_imperial_senate.png</img> Imperial Senate
|
| bgcolor="#fafafa" |
*Race: '''ROMULANS'''
*ShortName: '''Romulans'''
*LongName: '''Romulan Star Empire'''

*HomeSystem: '''Romulus (pop: 355, growth: 4%)'''
**(1) Romulus I: volcanic (hostile), small (25 pop.)
**(2) Romulus Prime: terran (ideal), large (180 pop.)
**(3) Remus: desert (marginal), large (60 pop.)
**(4) Romulus IV: oceanic (comfortable), medium (90 pop.)
**(5) Romulus V: Asteroids (uninhabitable), (no pop.)
**(6) Romulus VI: GasGiant (uninhabitable), (no pop.)

*Color: '''Green'''
*HomeQuadrant: '''Beta'''
*CivilizationType: '''Empire'''
*TechCurve: '''TechCurve6'''
----
|-
| align="middle" | <img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/Buildings/rom_tal_shiar_headquarters.png</img> Tal Shiar Headquarters

<img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/Buildings/rom_naval_academy.png</img> Naval Academy

<img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/Buildings/rom_imperial_affairs_network.png</img> Imperial Affairs Network
|
| bgcolor="#fafafa" |
"The Romulans are a Beta Quadrant race from the planet Romulus, but are biological cousins of the Vulcans, as they are descended from those who rejected Surak's reforms during the Vulcan Time of Awakening approximately sixteen hundred years ago. The Romulan Star Empire is the Romulan state, and is one of the major powers in known space.

Some theorize that the Vulcans - and therefore also the Romulans - are descended from Sargon's people, a race who possibly colonized the planet Vulcan some six million years ago. This theory, however, was later contradicted by the discovery of ancient humanoid progenitor remains on Vulcan.

When Surak's reforms of embracing logical principles and rejecting emotion spread rapidly across Vulcan in the 4th century, a minority rejected Surak's ideals; they chose to depart Vulcan rather than accept his teachings. Some of the descendents of these exiles are known to have established settlements on the planets Calder II, Dessica II, Draken IV, Yadalla Prime and Barradas III. These planets later formed the core worlds of the Debrune Empire, but infighting and lack of resources quickly took their toll, and the fledgling Debrune Empire collapsed.

At some point, another group settled on the twin planets that came to be known as Romulus and Remus. Whilst both planets were habitable Minshara-class planets, Romulus was stable and inviting, but Remus was tilted on an unusual axis that resulted in half of the planet being bathed in perpetual sunlight, whilst the other was shrouded in perpetual darkness. The only truly habitable zone of the planet was found near the boundary between night and day, and even in this region, conditions are harsh. But the Romulans encountered the native Reman race in this habitable zone, and quickly learned to exploit the Reman people as slaves and fearsome ground troops. The later discovery of abundant dilithium deposits on Remus eventually allowed the Romulans to develop interstellar capabilities, and solidified the union of the twin worlds. This union eventually became the foundation of an interstellar Empire that has since expanded to many worlds, reaching across much of the Beta Quadrant. That power eventually came to be known as the Romulan Star Empire."

<img>http://botf2.square7.ch/wiki-files/images/_Screenshots/2-2-System-Structures/2-2-System-Romulus-SomeStructures.jpg</img>

|}

[[Category:Races]]

*Additions: '''Consider adding Shock Troop Center'''

For the Shock Troop Centre I've been reading the various wiki sites on Remens and have taken the best bits to make this up. Hopefully it does the job or at least gives you guys what you need to write something cooler! :)
The Shock Troop Centre trains Reman slaves to become excellent warriors so that they can be exploited by Romulan commanders. During war time these warriors are used as "cannon fodder" by the Romulan military and placed in the fiercest engagements. Their skills in combat and their imposing nature also allows them to be used a personal bodyguards for the Romulan elite.

Federation

2021-09-26T06:10:50Z

Reginald: /* United Federation of Planets */

== United Federation of Planets ==
{| width="80%" bgcolor="#b3b8f4" style="border:2px solid #7d85e6;padding:1em;padding-top:0.5em;"

|valign="center" align="center" | <img>http://botf2.square7.ch/wiki-files/images/Civilizations/federation.png</img>

| width="1%" bgcolor="#b3b8f4" |

| bgcolor="#fafafa" width="90%" - valign="top"|
The United Federation of Planets is a coalition of worlds bound by a mutual desire for peace, the pursuit of scientific understanding, and trade. By far however, the most numerous of the Federation races is one of the founding members, the Humans of Sol. The people of the Federation live in a society based on the values of liberty and equality. Their strength lies in extremely effective research, which grants them fast access to new technologies. They are also efficient in industry, the mining of raw materials, and the production and supply of energy and vital goods to their planets. Their high-quality products come at the expense of high resource costs, however. Because of their moral convictions, they quickly show weaknesses in the field of espionage, but they make up for this with impressive, well-rounded starships, which function as well individually as in groups. Federation starships are equally likely to be seen conducting trade, exploration, humanitarian, and diplomatic missions, as they are to be seen conducting military patrols and combat manoeuvres.

<img>http://botf2.square7.ch/wiki-files/images/_Screenshots/1---Galaxy/Systems/Sol.png</img>

|-
|bgcolor="#b3b8f4" align="middle" | <img size=120>http://botf2.square7.ch/wiki-files/images/Insignias/federation.png</img>
|
| bgcolor="#fafafa" |
*Race: '''HUMANS'''
*ShortName: '''Federation'''
*LongName: '''United Federation of Planets'''

*HomeSystem: '''Sol''' (pop: 300, growth: 3,5%): Mercury, Venus, Earth, Mars, Asteroids, Jupiter, Saturn, Uranus, Neptune, Pluto

*Color: '''Blue'''
*HomeQuadrant: '''Alpha'''
*CivilizationType: '''Empire'''
*TechCurve: '''TechCurve6'''

|-
|bgcolor="#b3b8f4" align="middle" | <img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/Buildings/fed_federation_council.png</img> Federation Council

<img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/Buildings/fed_starfleet_academy.png</img> Starfleet Academy

<img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/Buildings/fed_private_farms.png</img> Private Farms
|
| bgcolor="#fafafa" |
"A founding member of the United Federation of Planets, the Humans of Earth became warp-capable in 2063, only moments before they officially experienced first contact with an alien species, the Vulcans, who by pure coincidence happened to have sent a survey vessel to explore the Sol system at the same time as Humanity's first warp flight. The Humans were still recovering from their third world war that had taken place a decade earlier - a nuclear war that had destroyed all centres of power, and wiped out two-thirds of the planetary population - and desperately welcomed the Vulcans with open arms. First contact had a profound effect on the Humans, and in just 10 years Earth began to stand on its own two feet again, and, under the careful guidance of the Vulcans, the Humans turned their attention to science and peaceful exploration amongst the stars.

By the 24th century, Human society had changed from what it was for most of recorded history. On Earth, hunger, war, disease, famine, and poverty had largely been eliminated. The acquisition of wealth was no longer the primary driving force in the lives of many Humans, and a great deal of emphasis was instead placed on the importance of continued societal and self-growth. Thanks to the non-currency based New World Economy and the development of replicators, material needs had been largely satisfied. Although money was no longer in use by Humans within the Federation, they did use gold-pressed Latinum and other forms of currency (such as Bajoran litas and credits) in places where it is still needed, such as Quark's Bar on the Deep Space Nine station. The idea behind not using money is that Humans work to better themselves and the rest of Humanity. It must however be noted that all of this more specifically applies to Humans within the Sol system, as many Earth colonies are known to have developed vast cultural differences from other Humans and some have even fallen into anarchy, most notably Turkana IV.

Whilst warp capability and first contact were first achieved in 2063, there were human populations on other planets prior to this date. In these cases, the Humans were usually brought there by alien species that had travelled to Earth. For instance, Native Americans are known to have been transplanted to Amerind by an unknown alien race called the Preservers some time in the 19th century. In 2268, these transplanted Humans still lived as hunter-gatherers, and Captain James T. Kirk was adopted into one of the tribes of Amerind, becoming known as the god, Kirok.

The Humans are a rapidly advancing race, with an unquenchable thirst for knowledge. Whilst they are now peaceful, they will fight to the death if need be to ensure the survival of their culture, ideals, and people. Only time will tell exactly how far the Humans will go."

<img>http://botf2.square7.ch/wiki-files/images/_Screenshots/2-2-System-Structures/2-2-System-Sol-SomeStructures.jpg</img>
|}

[[Category:Races]]

Terran Empire

2021-09-25T11:23:32Z

Reginald: /* Terran Empire */

== Terran Empire ==
{| width="80%" bgcolor="#b3b8f4" style="border:2px solid #7d85e6;padding:1em;padding-top:0.5em;"

|valign="center" align="center" | <img>http://botf2.square7.ch/wiki-files/images/Civilizations/terranempire.png</img>

| width="1%" bgcolor="#b3b8f4" |

| bgcolor="#fafafa" width="90%" - valign="top"|
Form a Alternate Timeline where the Federation was never founded. The terran empire is one of conquest and will kill or enslave you if you do not bend to there will.

<img>http://botf2.square7.ch/wiki-files/images/_Screenshots/1---Galaxy/Systems/Sol.png</img>

|-
|bgcolor="#b3b8f4" align="middle" | <img size=120>http://botf2.square7.ch/wiki-files/images/Insignias/TERRANEMPIRE.png</img>
|
| bgcolor="#fafafa" |
*Race: '''TERRANS'''
*ShortName: '''Terran Empire'''
*LongName: '''Terran Empire'''

*HomeSystem: '''Sol''' (pop: 300, growth: 3,5%): Mercury, Venus, Earth, Mars, Asteroids, Jupiter, Saturn, Uranus, Neptune, Pluto

*Color: '''Yellow'''
*HomeQuadrant: '''Alpha'''
*CivilizationType: '''Empire'''
*TechCurve: '''TechCurve6'''

|-
|bgcolor="#b3b8f4" align="middle" |

<img size=275>http://botf2.square7.ch/wiki-files/images/TechObjects/Ships/terran_cruiser_i.png</img> Terran Cruiser

|
| bgcolor="#fafafa" |

<img>http://botf2.square7.ch/wiki-files/images/_Screenshots/2-2-System-Structures/2-2-System-Sol-SomeStructures.jpg</img>
|}

[[Category:Races]]

Sound

2021-08-29T11:00:56Z

Reginald: /* Files */

= Intro =

*Folder: \SoundFX
*Folder racespecific: \UI\subfolder e.g. \UI\Dominion\ContextMenu\mousesnd.wav (not sure if it works)

On some parts only WAV works, e.g. while starting the game. After the Game is started other files like OGG / FLAC / MP3 are working in general. But always try it !

*[http://botf2.square7.ch/wiki-files/SoundFX/ChatMessage.wav ChatMessage.wav]
*RedAlert.wav
*NewTurn.wav

*\SoundFX\[[Menue|Menu]] (working)
*\SoundFX\[[System Assault#GroundCombat|GroundCombat]] (working)
*\SoundFX\[[Scripted Event|ScriptedEvents]] (working)
*\SoundFX\[[TaskForceOrder]]s (disabled, because Game freeze quite often)

Missing sound files are shown in Log.txt

== FMOD ==

*http://star-trek-supremacy.proboards.com/post/5322/thread

[[category:Audio]]
== Files ==

=== MP3 ===

*e.g. \Resources\Music\Trek Opening.mp3

=== OGG ===

*e.g. \Resources\Music\Dominion System.ogg

=== FLAC ===

*e.g. \Resources\SoundFX\TaskForceOrders\BorgWeAreTheBorg.flac

=== WAV ===

*\Resources\SoundFX\NewTurn.wav

=== WMA ===

*e.g. \Resources\SoundFX\ScriptedEvents\ReligiousHoliday.wma

== Star Trek Sounds ==

* https://www.trekcore.com/audio/

Source Code

2021-05-09T12:32:11Z

Reginald: /* Improvement */

== Source Code ==

http://guganeshan.com/blog/setting-up-git-and-tortoisegit-with-bitbucket-step-by-step.html

=== official ===

* code is now at https://github.com/BotF2/BotF2.git

*last source code https://bitbucket.org/mstrobel/supremacy/overview (it's in C#, also named CSharp. [[#Visual Studio]] is used for coding.)
**Mike's Post: build in [http://www.microsoft.com/downloads/dlx/en-us/ThankYou.aspx?FamilyID=75568AA6-8107-475D-948A-EF22627E57A5 VS2010] with .NET 4.0. You may need the [http://en.csharp-online.net/Download_Free_Microsoft_Visual_CSharp_.NET#Download_Microsoft_Visual_Studio_Async_Community_Technology_Preview_.28CTP.29 C# Async CTP]. http://bote2.square7.ch/forum/viewtopic.php?p=70790#p70790
**http://bote2.square7.ch/forum/viewtopic.php?p=70781#p70781
*** Supremacy.Game.GameEngine is where you'll find most of the game logic. That's where most of the turn processing happens.
*** The SupremacyCore project is where you'll find the foundation of the game.
*** SupremacyService is just the game server (all the important bits it interacts with are in SupremacyCore).
*** SupremacyClientComponents is UI infrastructure.
*** SupremacyUI and SupremacyWPF are older UI infrastructure stuff, much of which has been phased out and replaced by newer and better stuff in SupremacyClientComponents. The most interesting stuff in SupremacyUI is GalaxyGridPanel, which draws the galactic map. It also has the spinning planet views.
*** Supremacy.Xna is where the XNA/3D stuff is located--it's not used heavily yet, but it has some effects for the invasion screen, a newer star renderer, a 3D spinning ship renderer, etc.
*** Supremacy.Scripting is an expression language parser/compiler.
*** SupremacyClient is the main graphical client and has most of the game screen implementations.

*old source code can be taken from here: http://supremacy.codeplex.com/ (last upload from MStrobel at 03.01.2011)

==== ClientContext vs AppContext ====

taken from https://bitbucket.org/kflanagan/supremacydev/commits/0d562ce676425cd5da19cfdbcf1b6c18c7d0d135

*IClientContext is used by SupremacyCore to interface clients participating on a game, both local and over network. The IClientContext further includes an interface to IGameContext which gives access to the game data itself inside the '''SupremacyClient app'''
*However there should be an option to also include local properties not known to the Core, which is why this is done alternatively another context would have to be introduced for local data, but then still all the client code would have to be updated to make use of it

==== .XAML files ====

In Windows Presentation Foundation (WPF), a windows app framework used by Supremacy, XAML forms a user interface markup language to define UI elements, data binding, events, and other features.

Info resources:

*MS Article: [https://msdn.microsoft.com/en-us/library/ms745683(v=vs.110).aspx XAML Styling and Templating]

*Youtube video: [https://www.youtube.com/watch?v=0qE5hyuU9hE Introduction to XAML] (26min)

== Bitbucket ==

*https://confluence.atlassian.com/display/BITBUCKET/Maintaining+a+Mercurial+Repository

== Changes ==

see [[ChangeLog|here]] or https://bitbucket.org/mstrobel/supremacy/commits/branch/default

=== 2016 ===

==== XAML ====

*January 2016 [Planned]: Hope to get Major Race specific UI build through use of generic XAML files.
* ClientApp.xaml.cs has the code to direct UI to race specific folders of xaml files in SupremacyClient/themes/{0}

Looking at SystemScreen.xaml, Global.xaml and ClientModules.cs in Themes/SupremacyClient
See also generic.xaml in SupremacyClientComponents/Themes/InfoCard Theme.xaml Default.xaml Icons.xaml ClientApp.xaml.cs SystemScreen.xaml

1/17/16: Found that Mikes code in ClientApp.xaml.cs will already select for Major race. Need new folders for each major race in SupremacyClient/themes/(major race), edit paths to Resources in the .xaml files found in each races set of .xaml files. File names in SupremacyClient/themes/(major race) are not unique but content in Resources is. Now you can edit files in Resources for unique UI.

2/13/16:

<Polygon
Points="300,200 400,125 400,275 300,200"
Stroke="Purple"
StrokeThickness="2">
<Polygon.Fill>
<SolidColorBrush Color="Blue" Opacity="0.4"/>
</Polygon.Fill>
</Polygon>

Makes a left pointing triangle, purple outline and blue body

=== 2015 ===

*'''Animation.cs''' (animation of opening screen): This is where we can set the number of images, frames, and the rate they play at, currently all images in 30 seconds. We may want that to run faster. The images you will make for the ship de-cloaking will be located in Resources / Images / Animation.
* \supremacyclient\'''ClientModule.cs''':
**Found a place to add the right mouse click instructions for the Panel Access Menu. A thing called the statusWindow held the text "loading" while you wait for a game to load. Added the information there for new players

*FMOD is partly replace by AudioEngine.cs and others - just find it out

=== 2014 ===

== some code ==

for Theme and UI see >> '''[[Theme]]'''

=== miscellaneous ===

*Mainline\SupremacyClient\GameContextMenu.cs

*\Mainline\SupremacyUI\SystemProductionPanel.cs

*\Mainline\SupremacyCore\Orbitals\FleetOrders.cs -> all items inside a sector

*Mainline\SupremacyClient\GameContextMenu.cs (Access Popup Menu - or use F1 to F5)

*\Mainline\SupremacyClientComponents\Controls\InfoCard\InfoCard.cs (-> Tooltips ??)
**\Mainline\SupremacyClient\themes\Federation\InfoCard.xaml -> <Setter Property="Width" Value="500" /> (BEFORE: 250)

*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyPlanetaryBuildQueueView.xaml - Colonies Screen Content

*\Mainline\SupremacyCore\Universe\Colony.cs
*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyStructureListView.xaml
**Size of this area: 720 x 240

*\Mainline\SupremacyClient\Views\GalaxyScreen\TaskForceListView.xaml

=== Version Number ===

Look for version number control in AssemblyInfo.cs

your hard disk code folder BotF2\SupremacyClient\Properties\AssemblyInfo.cs

---
example code: (put in your current star date)

*[assembly: AssemblyVersion("2018.11.20.0")]
*[assembly: AssemblyFileVersion("2018.11.20.0")]

=== Ships ===

*\Fleets.cs
*\FleetOrder.cs (without a "s" - beware of it)
*\FleetOrders.cs

*\mainline\supremacyclientcomponents\views\galaxyscreen\galaxyscreenpresenter.cs TaskForcesList

==== Building Ships ====

*Cancelling -> Breakpoint at Line 185 at OnShipyardBuildProjectsChanged() \Mainline\SupremacyClientComponents\Views\ColonyScreen\ColonyScreenPresentationModel.cs

=== Sounds ===

*\Mainline\SupremacyClient\AudioEngine.cs (for Music), for Sounds >> SoundPlayerAction is used (search for \Resources\UI\Federation\SoundsButtonClick.wav)
*and in \Mainline\SupremacyClientComponents\Views\SystemAssaultScreen\SystemAssaultScreenViewModel.cs -> Uri is used (e.g. CombatLaser.wav)

=== Galaxy Generator ===

*\Mainline\SupremacyCore\Universe\GalaxyGenerator.cs

=== Values ===
*CivID: 0 = Federation...

=== TurnPhase ===

WaitOnPlayers = 0,
PreTurnOperations,
ResetObjects,
FleetMovement,
Combat,
PopulationGrowth,
PersonnelTraining,
Research,
Scrapping,
Maintenance,
ShipProduction,
Production,
Trade,
Morale,
MapUpdates,
PostTurnOperations,
SendUpdates,
Diplomacy,
WaitOnAIPlayers

=== older list ===

{|class="wikitable sortable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |where
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Folder
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |File
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Function
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Date
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Description
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameContext.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
initialising game
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|
Raw Materials, Deuterium, Dilithium is collected cross over all colonies and used by all colonies
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoShipProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|

|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Combat
|style=text-align:center|InvasionArena.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
SystemAssault
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Orbital
|style=text-align:center|Shipyard.cs
|style=text-align:center|GetBuildOutput(int slot)
|style=text-align:center| [https://bitbucket.org/Bloodwurm/BotF2dev/commits/1aafc8f6e47e9e3b9c20de79f2d02f197c023d63 2014-01-15]
|style=text-align:left|
just selects output (active?) and bonus (BonusType.PercentShipBuilding), since 2014-01-15 also case PopulationRatio or IndustryRatio
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|GetProductionOutput(ProductionCategory category)
|style=text-align:center|
|style=text-align:left|
see last line, too !
*Food: minimum 10
*Research:
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*Industry: '''minimum 10 !'''
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*last line: return ((int)(baseOutput + (baseOutput * modifier.Efficiency)) + modifier.Bonus);
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasFoodBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasFoodBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasEnergyBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasEnergyBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-ClientComp
|style=text-align:center|Views\GalaxyScreen
|style=text-align:center|GalaxyScreenView.cs
|style=text-align:center|GalaxyScreenView()
|style=text-align:center|
|style=text-align:left|GalaxyView Hotkeys Definition (see [[Hotkey]]s)
|style=text-align:left|
|style=text-align:left|

|}

== Botf2-coding-practice ==

*http://star-trek-supremacy.proboards.com/thread/349/botf2-coding-practice (intern)

*prepare:
**...we are using SourceTree, provided by bitbucket (another option: TortoiseHg with Mercurial - to access the supremacy code repository http://tortoisehg.bitbucket.org/)
**PuTTYgen - to generate a ssh key to allow using ssh protocol instead of slow https http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
***or use C:\Program Files (x86)\Atlassian\SourceTree\tools\putty..puttygen.exe....generate a key (using a phrase is not neccessary)
***copy the public key (4-5 lines) into your bitbucket account/profile under SSH Keys, label it with any title and CopyPaste
**we are using Visual Studio Community 2013 Update 4 (select the Community Version) https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
**we are not(!) using Visual Studio Community 2015 RC - to compile the code (ISO is recommend)....still need to check if Supremacy code compiles with it, so instead we might need to depend on VS2013 http://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs....for VS 2015 we read to create a new project, import Supremacy and go through all the issues
**you also need to have an account on http://bitbucket.org
**and you should have Skype installed to participate in the meetings we have

*when you attempt to clone by ssh instead of https, check the following tutorial: http://confluence.atlassian.com/display/BITBUCKET/Set+up+SSH+for+Mercurial

*here some simple text editors useful to edit stuff like xml files, just pick the one you prefer they all are great:
**http://www.sublimetext.com/
**http://www.contexteditor.org/index.php
**http://notepad-plus-plus.org/ (used by reg atm)

== SourceTree ==

*Download >> https://www.sourcetreeapp.com/?v=win (or while cloning...use the link below blue Clone Button)

*Tools: 3rd point: OPTIONS

*SSH Client Configuration:
**SSH Key: c:\....\ReginaldPutty.ppk
**SSH Client: (IMPORTANT) PuTTY/Link (not SSH !!)
**automatically start: yes

== Visual Studio ==

It's possible (and standard) to compile the game with Visual Studio. No further stuff of programs is needed, except matching Resources folder. Mention that the compiled exe is then in \Mainline\bin\Debug (or \Release).

=== VS2019 ===

* meanwhile we are on VS 2019 Community version https://www.visualstudio.com/downloads

* see hints for VS 2017 especially >> Set as Start Project > SupremacyClient (View SolutionExplorer > SupremacyClient > right mouse click ...in the middle)

==== Improvement ====

old: var handler = TurnNumberChanged;
if (handler != null)
handler(this, EventArgs.Empty);
New: TurnNumberChanged?.Invoke(this, EventArgs.Empty);

old: if (baseScheduler == null)
throw new ArgumentNullException("baseScheduler");
new: _baseScheduler = baseScheduler ?? throw new ArgumentNullException("baseScheduler");

=== VS2017 ===

In May 2017 we're trying to change to VS 2017 Community version https://www.visualstudio.com/downloads

*you might want to change language at TOOLS > OPTIONS > ENVIROMENT > INTERNATIONAL SETTINGS

* first make a clean !!, maybe for each single project (10 of 10)

* SOLUTION EXPLORER - right mouse click - retarget (in the middle) - select newest versions

* (this should be only needed once and should be uploaded to Repository by one guy) SupremacyClient > Set as start Project

*after cleaning maybe use REBUILD

for more see >> [[#Tools|here]]

=== VS2015 ===

since April 2016 we're using VS 2015

*Visual Studio '''Community''' 2015 RC - to compile the code (ISO is recommend) ... still need to check if Supremacy code compiles with it, so instead we might need VS2013. NEW: we try to go to VS 2015 now.
https://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs - you need the "Community" Version, currently (Apr 2016) version "Update 2"

==== VS 2015 Update 3 ====

*says it does uninstall Update 2
*needs update to 33 GB to install (only if every is selected) - seems to need some hours...

=== old VS ===

this is out of date due to code has changed

==== Visual C++ Library ====

IMPORTANT: As Microsoft no longer provides Visual C++ Library as standard installed component ...don't forget to select or install this manually! In VS you can recognize it if \Supremacy Native is unload (sign is greyed out a little bit)

===== SupremacyNative =====

SupremacyNative is C++ coded. Sometimes there are some problems with it https://developercommunity.visualstudio.com/content/problem/312852/internal-compiler-error-in-vs158-msc1cpp-line-1518.html

*Visual Studio Community 2013 (Community version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2012 (Express version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2008 (German) http://www.microsoft.com/de-de/download/details.aspx?id=13276

=== Tools ===

*Indent Guides https://visualstudiogallery.msdn.microsoft.com/e792686d-542b-474a-8c55-630980e72c30 Adds vertical lines at each indent level.

* Vertical tabs https://marketplace.visualstudio.com/items?itemName=VisualStudioProductTeam.ProductivityPowerPack2017

*PowerShell Tools für VS 2015

=== Tips ===
*TOOLS > OPTIONS > ENVIRONMENT > Color theme -> Black

*TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Detect when file is changed outside... -> Yes
**TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Reload modified files... -> Yes

*DEBUG > OPTIONS > PROJECTS... > BUILD AND RUN > when code=project is changed="out of date" > "Always Build" (checkbox "only build ...on Run" is marked)
**https://www.vb-paradise.de/index.php/Thread/47935-Code-bei-Klick-auf-Debugging-starten-kompilieren-wenn-er-sich-ge%C3%A4ndert-hat/

*TOOLS > OPTIONS > TEXT EDITOR > ALL LANGUAGES > Line Number (activate for all)

*DEBUG > SUPREMACY CLIENT PROPERTIES (last) > DEBUG > Start project > Command line arguments: "-aiexplore -SAVEDGAME:auto" (if you save in Supremacy manually a game with name "auto" (independent from game's "(autosave)", this manually saved game can be loaded at startup.
**"-aiexplore" isn't necessary. For more see [[Command line parameter]]
**if working for example on Cardassian UI just save Cardassian as "auto".
**when you want to change to Klingons, just retire and start Klingons. If you want to work steady on Klingons, save a Klingon's game with auto.
**if you want to start a new game steady, just go Command line arguments (see above) and change the filename to an unused one like "-SAVEDGAME:auto123"

*activate Toolbar BUILD by right mouse click on Toolbar line

* Tools -> Options -> Debugging -> Output Window -> Module Load Messages -> Off

==== Editor ====
we're using some different editors
*one option is to drag'n'drop files like xml to Visual Studio
*sometimes we use Notepad++ https://notepad-plus-plus.org/download with Extension Compare (PLUGINS > PLUGIN MANAGER > SHOW P-Manager > "Compare" ...install
*for a black style we use Sublime http://www.sublimetext.com/2

==== Screenshot ====

*reg likes Greenshot http://getgreenshot.org/
**puts an icon into task bar. There: > PREFERENCES
***PREFERENCES > GENERAL: reg uses for "Capture region" CRTL+PRNT (and no other hotkey)
***PREFERENCES > OUTPUT: define a folder at "Storage location" and a standard file type (default is *.png)
***PREFERENCES > DESTINATION: (reg's settings)
****- turn off "Select destination dymnamically"
****- open in image editor
****- copy to clipboard
**Usage:
***press Hotkey and make Screenshot
***paste immediately anywhere OR
***work on it inside Greenshot (give red circles or mark up in any colour), give numbers, obfuscate and more
***save or save as jpg or print

== Compiling ==

if you have an error with "Glyphs.xaml", than make sure you have copied \Resources MANUALLY into the output folders - this was changed in 2015. The output folder depends on compiling method "Debug" or "Release", it is
*for DEBUG _: (YourRepositoryFolder)\Mainline\bin\'''Debug\Resources''' or
*for RELEASE: (YourRepositoryFolder)\Mainline\bin\'''Release\Resources'''

it's creating:
*1> Supremacy.Scripting -> %path_repo%\bin\Debug\lib\Supremacy.Scripting.dll
*2> SupremacyCore -> %path_repo%\bin\Debug\lib\SupremacyCore.dll
*3> Supremacy.Xna -> %path_repo%\bin\Debug\lib\Supremacy.Xna.dll
*4> SupremacyClientComponents -> %path_repo%\bin\Debug\lib\SupremacyClientComponents.dll
*5> SupremacyWPF -> %path_repo%\bin\Debug\lib\SupremacyWPF.dll
*6> SupremacyService -> %path_repo%\bin\Debug\lib\SupremacyService.dll
*7> SupremacyUI -> %path_repo%\bin\Debug\lib\SupremacyUI.dll

== Visual C# ==

build in Visual Studio

<img>http://botf2.square7.ch/wiki-files/images/VS2015.jpg</img>

== SunBurn ==

SunBurn is on hold for now. Kenneth was working sometimes with SunBurn...this might be a site for this http://channel9.msdn.com/coding4fun/blog/No-need-for-sunscreen-you-want-this-SunBurn-SunBurn-v2-RTMs-including-the-free-SunBurn-Framework-Edi

*http://en.wikipedia.org/wiki/List_of_game_engines

== .Net ==

you should use latest [http://www.microsoft.com/net .Net-version] (2014: version 4.5.1)

== XNA ==

"Could not load file or assembly 'Microsoft.Xna.Framework.dll' or one of its dependencies. The specified module could not be found."

*suggestion by reg: go to \Resources\Models and rename the "Models"-folder to "Models-SetOffline" or something else (if building a ship no model is shown -as it is to most of the ships- but otherwise the game could work fine)

This suggests the problem is with your XNA installation. The game uses XNA to display the 3D ship models in the shipyard. There's no way to disable the models so XNA wouldn't be needed. So to be able to play the game, i'd advise to uninstall XNA, then install the latest version.

XNA 3.1 (this one you need in any case): http://www.microsoft.com/en-us/download/details.aspx?id=15163

XNA 4.0 Download link: http://www.microsoft.com/en-gb/download/details.aspx?id=20914

== Try ==

(for boolean)

try
{
return true;
}
catch (Exception e)
{
var errors = new System.Collections.Concurrent.ConcurrentStack<Exception>();
errors.Push(e);
return false;
}
finally
{
xxx;
}
;

== Contexts ==

*AppContext (programm running)
*GameContext.Current (Game started - so after StartScreen)
*PlayerContext.Current

== Text ==
=== en.txt ===
* XAML example: Text="{s:StringResource EMPIRES_HEADER}"
* string _text = String.Format(ResourceManager.GetString("KEY_IN-EN_TXT"),parameter1, parameter2;

== LocalPlayer ==

*AppContext.LocalPlayer (just inside XAML-code files ??)
* _appContext.LocalPlayer.Empire

== Civilization ==

just the data out of Civilization.xml ... for more see [[#CivilizationManager]]

== CivilizationManager ==

CivilizationManager holds all the data like amount of credits, diplomacy, sitreps and more

*GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

== GameLog ==

if not available, try "Quick actions" -> using Supremacy.Utility;

GameLog.Core.GameData.DebugFormat("Turn {0};xx=;{1};xx=;{2};xx={3};xx={4};xx={5};xx={6};xx={7};xx={8};xx={9};"
, GameContext.Current.TurnNumber
, xx
, xx
);

== Dictionary ==

private static Dictionary<string, bool> _acceptRejectDictionary = new Dictionary<string, bool> { { "98", false } };

== MessageBox (Windows Style) ==

MessageBox.Show("Borg turned into Expanded", "WARNING", MessageBoxButton.OK);

== MessageDialog (Supremacy Style) ==

var result = MessageDialog.Show("Borg turned into Expanded", MessageDialogButtons.YesNo);

== SoundPlaying ==

* _soundPlayer.PlayFile("Resources/SoundFX/ChatMessage.wav");

Source Code

2021-05-09T11:43:35Z

Reginald: /* VS2019 */

== Source Code ==

http://guganeshan.com/blog/setting-up-git-and-tortoisegit-with-bitbucket-step-by-step.html

=== official ===

* code is now at https://github.com/BotF2/BotF2.git

*last source code https://bitbucket.org/mstrobel/supremacy/overview (it's in C#, also named CSharp. [[#Visual Studio]] is used for coding.)
**Mike's Post: build in [http://www.microsoft.com/downloads/dlx/en-us/ThankYou.aspx?FamilyID=75568AA6-8107-475D-948A-EF22627E57A5 VS2010] with .NET 4.0. You may need the [http://en.csharp-online.net/Download_Free_Microsoft_Visual_CSharp_.NET#Download_Microsoft_Visual_Studio_Async_Community_Technology_Preview_.28CTP.29 C# Async CTP]. http://bote2.square7.ch/forum/viewtopic.php?p=70790#p70790
**http://bote2.square7.ch/forum/viewtopic.php?p=70781#p70781
*** Supremacy.Game.GameEngine is where you'll find most of the game logic. That's where most of the turn processing happens.
*** The SupremacyCore project is where you'll find the foundation of the game.
*** SupremacyService is just the game server (all the important bits it interacts with are in SupremacyCore).
*** SupremacyClientComponents is UI infrastructure.
*** SupremacyUI and SupremacyWPF are older UI infrastructure stuff, much of which has been phased out and replaced by newer and better stuff in SupremacyClientComponents. The most interesting stuff in SupremacyUI is GalaxyGridPanel, which draws the galactic map. It also has the spinning planet views.
*** Supremacy.Xna is where the XNA/3D stuff is located--it's not used heavily yet, but it has some effects for the invasion screen, a newer star renderer, a 3D spinning ship renderer, etc.
*** Supremacy.Scripting is an expression language parser/compiler.
*** SupremacyClient is the main graphical client and has most of the game screen implementations.

*old source code can be taken from here: http://supremacy.codeplex.com/ (last upload from MStrobel at 03.01.2011)

==== ClientContext vs AppContext ====

taken from https://bitbucket.org/kflanagan/supremacydev/commits/0d562ce676425cd5da19cfdbcf1b6c18c7d0d135

*IClientContext is used by SupremacyCore to interface clients participating on a game, both local and over network. The IClientContext further includes an interface to IGameContext which gives access to the game data itself inside the '''SupremacyClient app'''
*However there should be an option to also include local properties not known to the Core, which is why this is done alternatively another context would have to be introduced for local data, but then still all the client code would have to be updated to make use of it

==== .XAML files ====

In Windows Presentation Foundation (WPF), a windows app framework used by Supremacy, XAML forms a user interface markup language to define UI elements, data binding, events, and other features.

Info resources:

*MS Article: [https://msdn.microsoft.com/en-us/library/ms745683(v=vs.110).aspx XAML Styling and Templating]

*Youtube video: [https://www.youtube.com/watch?v=0qE5hyuU9hE Introduction to XAML] (26min)

== Bitbucket ==

*https://confluence.atlassian.com/display/BITBUCKET/Maintaining+a+Mercurial+Repository

== Changes ==

see [[ChangeLog|here]] or https://bitbucket.org/mstrobel/supremacy/commits/branch/default

=== 2016 ===

==== XAML ====

*January 2016 [Planned]: Hope to get Major Race specific UI build through use of generic XAML files.
* ClientApp.xaml.cs has the code to direct UI to race specific folders of xaml files in SupremacyClient/themes/{0}

Looking at SystemScreen.xaml, Global.xaml and ClientModules.cs in Themes/SupremacyClient
See also generic.xaml in SupremacyClientComponents/Themes/InfoCard Theme.xaml Default.xaml Icons.xaml ClientApp.xaml.cs SystemScreen.xaml

1/17/16: Found that Mikes code in ClientApp.xaml.cs will already select for Major race. Need new folders for each major race in SupremacyClient/themes/(major race), edit paths to Resources in the .xaml files found in each races set of .xaml files. File names in SupremacyClient/themes/(major race) are not unique but content in Resources is. Now you can edit files in Resources for unique UI.

2/13/16:

<Polygon
Points="300,200 400,125 400,275 300,200"
Stroke="Purple"
StrokeThickness="2">
<Polygon.Fill>
<SolidColorBrush Color="Blue" Opacity="0.4"/>
</Polygon.Fill>
</Polygon>

Makes a left pointing triangle, purple outline and blue body

=== 2015 ===

*'''Animation.cs''' (animation of opening screen): This is where we can set the number of images, frames, and the rate they play at, currently all images in 30 seconds. We may want that to run faster. The images you will make for the ship de-cloaking will be located in Resources / Images / Animation.
* \supremacyclient\'''ClientModule.cs''':
**Found a place to add the right mouse click instructions for the Panel Access Menu. A thing called the statusWindow held the text "loading" while you wait for a game to load. Added the information there for new players

*FMOD is partly replace by AudioEngine.cs and others - just find it out

=== 2014 ===

== some code ==

for Theme and UI see >> '''[[Theme]]'''

=== miscellaneous ===

*Mainline\SupremacyClient\GameContextMenu.cs

*\Mainline\SupremacyUI\SystemProductionPanel.cs

*\Mainline\SupremacyCore\Orbitals\FleetOrders.cs -> all items inside a sector

*Mainline\SupremacyClient\GameContextMenu.cs (Access Popup Menu - or use F1 to F5)

*\Mainline\SupremacyClientComponents\Controls\InfoCard\InfoCard.cs (-> Tooltips ??)
**\Mainline\SupremacyClient\themes\Federation\InfoCard.xaml -> <Setter Property="Width" Value="500" /> (BEFORE: 250)

*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyPlanetaryBuildQueueView.xaml - Colonies Screen Content

*\Mainline\SupremacyCore\Universe\Colony.cs
*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyStructureListView.xaml
**Size of this area: 720 x 240

*\Mainline\SupremacyClient\Views\GalaxyScreen\TaskForceListView.xaml

=== Version Number ===

Look for version number control in AssemblyInfo.cs

your hard disk code folder BotF2\SupremacyClient\Properties\AssemblyInfo.cs

---
example code: (put in your current star date)

*[assembly: AssemblyVersion("2018.11.20.0")]
*[assembly: AssemblyFileVersion("2018.11.20.0")]

=== Ships ===

*\Fleets.cs
*\FleetOrder.cs (without a "s" - beware of it)
*\FleetOrders.cs

*\mainline\supremacyclientcomponents\views\galaxyscreen\galaxyscreenpresenter.cs TaskForcesList

==== Building Ships ====

*Cancelling -> Breakpoint at Line 185 at OnShipyardBuildProjectsChanged() \Mainline\SupremacyClientComponents\Views\ColonyScreen\ColonyScreenPresentationModel.cs

=== Sounds ===

*\Mainline\SupremacyClient\AudioEngine.cs (for Music), for Sounds >> SoundPlayerAction is used (search for \Resources\UI\Federation\SoundsButtonClick.wav)
*and in \Mainline\SupremacyClientComponents\Views\SystemAssaultScreen\SystemAssaultScreenViewModel.cs -> Uri is used (e.g. CombatLaser.wav)

=== Galaxy Generator ===

*\Mainline\SupremacyCore\Universe\GalaxyGenerator.cs

=== Values ===
*CivID: 0 = Federation...

=== TurnPhase ===

WaitOnPlayers = 0,
PreTurnOperations,
ResetObjects,
FleetMovement,
Combat,
PopulationGrowth,
PersonnelTraining,
Research,
Scrapping,
Maintenance,
ShipProduction,
Production,
Trade,
Morale,
MapUpdates,
PostTurnOperations,
SendUpdates,
Diplomacy,
WaitOnAIPlayers

=== older list ===

{|class="wikitable sortable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |where
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Folder
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |File
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Function
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Date
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Description
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameContext.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
initialising game
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|
Raw Materials, Deuterium, Dilithium is collected cross over all colonies and used by all colonies
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoShipProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|

|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Combat
|style=text-align:center|InvasionArena.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
SystemAssault
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Orbital
|style=text-align:center|Shipyard.cs
|style=text-align:center|GetBuildOutput(int slot)
|style=text-align:center| [https://bitbucket.org/Bloodwurm/BotF2dev/commits/1aafc8f6e47e9e3b9c20de79f2d02f197c023d63 2014-01-15]
|style=text-align:left|
just selects output (active?) and bonus (BonusType.PercentShipBuilding), since 2014-01-15 also case PopulationRatio or IndustryRatio
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|GetProductionOutput(ProductionCategory category)
|style=text-align:center|
|style=text-align:left|
see last line, too !
*Food: minimum 10
*Research:
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*Industry: '''minimum 10 !'''
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*last line: return ((int)(baseOutput + (baseOutput * modifier.Efficiency)) + modifier.Bonus);
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasFoodBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasFoodBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasEnergyBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasEnergyBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-ClientComp
|style=text-align:center|Views\GalaxyScreen
|style=text-align:center|GalaxyScreenView.cs
|style=text-align:center|GalaxyScreenView()
|style=text-align:center|
|style=text-align:left|GalaxyView Hotkeys Definition (see [[Hotkey]]s)
|style=text-align:left|
|style=text-align:left|

|}

== Botf2-coding-practice ==

*http://star-trek-supremacy.proboards.com/thread/349/botf2-coding-practice (intern)

*prepare:
**...we are using SourceTree, provided by bitbucket (another option: TortoiseHg with Mercurial - to access the supremacy code repository http://tortoisehg.bitbucket.org/)
**PuTTYgen - to generate a ssh key to allow using ssh protocol instead of slow https http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
***or use C:\Program Files (x86)\Atlassian\SourceTree\tools\putty..puttygen.exe....generate a key (using a phrase is not neccessary)
***copy the public key (4-5 lines) into your bitbucket account/profile under SSH Keys, label it with any title and CopyPaste
**we are using Visual Studio Community 2013 Update 4 (select the Community Version) https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
**we are not(!) using Visual Studio Community 2015 RC - to compile the code (ISO is recommend)....still need to check if Supremacy code compiles with it, so instead we might need to depend on VS2013 http://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs....for VS 2015 we read to create a new project, import Supremacy and go through all the issues
**you also need to have an account on http://bitbucket.org
**and you should have Skype installed to participate in the meetings we have

*when you attempt to clone by ssh instead of https, check the following tutorial: http://confluence.atlassian.com/display/BITBUCKET/Set+up+SSH+for+Mercurial

*here some simple text editors useful to edit stuff like xml files, just pick the one you prefer they all are great:
**http://www.sublimetext.com/
**http://www.contexteditor.org/index.php
**http://notepad-plus-plus.org/ (used by reg atm)

== SourceTree ==

*Download >> https://www.sourcetreeapp.com/?v=win (or while cloning...use the link below blue Clone Button)

*Tools: 3rd point: OPTIONS

*SSH Client Configuration:
**SSH Key: c:\....\ReginaldPutty.ppk
**SSH Client: (IMPORTANT) PuTTY/Link (not SSH !!)
**automatically start: yes

== Visual Studio ==

It's possible (and standard) to compile the game with Visual Studio. No further stuff of programs is needed, except matching Resources folder. Mention that the compiled exe is then in \Mainline\bin\Debug (or \Release).

=== VS2019 ===

* meanwhile we are on VS 2019 Community version https://www.visualstudio.com/downloads

* see hints for VS 2017 especially >> Set as Start Project > SupremacyClient (View SolutionExplorer > SupremacyClient > right mouse click ...in the middle)

==== Improvement ====

OLD: var handler = TurnNumberChanged;
if (handler != null)
handler(this, EventArgs.Empty);
New: TurnNumberChanged?.Invoke(this, EventArgs.Empty);

=== VS2017 ===

In May 2017 we're trying to change to VS 2017 Community version https://www.visualstudio.com/downloads

*you might want to change language at TOOLS > OPTIONS > ENVIROMENT > INTERNATIONAL SETTINGS

* first make a clean !!, maybe for each single project (10 of 10)

* SOLUTION EXPLORER - right mouse click - retarget (in the middle) - select newest versions

* (this should be only needed once and should be uploaded to Repository by one guy) SupremacyClient > Set as start Project

*after cleaning maybe use REBUILD

for more see >> [[#Tools|here]]

=== VS2015 ===

since April 2016 we're using VS 2015

*Visual Studio '''Community''' 2015 RC - to compile the code (ISO is recommend) ... still need to check if Supremacy code compiles with it, so instead we might need VS2013. NEW: we try to go to VS 2015 now.
https://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs - you need the "Community" Version, currently (Apr 2016) version "Update 2"

==== VS 2015 Update 3 ====

*says it does uninstall Update 2
*needs update to 33 GB to install (only if every is selected) - seems to need some hours...

=== old VS ===

this is out of date due to code has changed

==== Visual C++ Library ====

IMPORTANT: As Microsoft no longer provides Visual C++ Library as standard installed component ...don't forget to select or install this manually! In VS you can recognize it if \Supremacy Native is unload (sign is greyed out a little bit)

===== SupremacyNative =====

SupremacyNative is C++ coded. Sometimes there are some problems with it https://developercommunity.visualstudio.com/content/problem/312852/internal-compiler-error-in-vs158-msc1cpp-line-1518.html

*Visual Studio Community 2013 (Community version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2012 (Express version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2008 (German) http://www.microsoft.com/de-de/download/details.aspx?id=13276

=== Tools ===

*Indent Guides https://visualstudiogallery.msdn.microsoft.com/e792686d-542b-474a-8c55-630980e72c30 Adds vertical lines at each indent level.

* Vertical tabs https://marketplace.visualstudio.com/items?itemName=VisualStudioProductTeam.ProductivityPowerPack2017

*PowerShell Tools für VS 2015

=== Tips ===
*TOOLS > OPTIONS > ENVIRONMENT > Color theme -> Black

*TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Detect when file is changed outside... -> Yes
**TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Reload modified files... -> Yes

*DEBUG > OPTIONS > PROJECTS... > BUILD AND RUN > when code=project is changed="out of date" > "Always Build" (checkbox "only build ...on Run" is marked)
**https://www.vb-paradise.de/index.php/Thread/47935-Code-bei-Klick-auf-Debugging-starten-kompilieren-wenn-er-sich-ge%C3%A4ndert-hat/

*TOOLS > OPTIONS > TEXT EDITOR > ALL LANGUAGES > Line Number (activate for all)

*DEBUG > SUPREMACY CLIENT PROPERTIES (last) > DEBUG > Start project > Command line arguments: "-aiexplore -SAVEDGAME:auto" (if you save in Supremacy manually a game with name "auto" (independent from game's "(autosave)", this manually saved game can be loaded at startup.
**"-aiexplore" isn't necessary. For more see [[Command line parameter]]
**if working for example on Cardassian UI just save Cardassian as "auto".
**when you want to change to Klingons, just retire and start Klingons. If you want to work steady on Klingons, save a Klingon's game with auto.
**if you want to start a new game steady, just go Command line arguments (see above) and change the filename to an unused one like "-SAVEDGAME:auto123"

*activate Toolbar BUILD by right mouse click on Toolbar line

* Tools -> Options -> Debugging -> Output Window -> Module Load Messages -> Off

==== Editor ====
we're using some different editors
*one option is to drag'n'drop files like xml to Visual Studio
*sometimes we use Notepad++ https://notepad-plus-plus.org/download with Extension Compare (PLUGINS > PLUGIN MANAGER > SHOW P-Manager > "Compare" ...install
*for a black style we use Sublime http://www.sublimetext.com/2

==== Screenshot ====

*reg likes Greenshot http://getgreenshot.org/
**puts an icon into task bar. There: > PREFERENCES
***PREFERENCES > GENERAL: reg uses for "Capture region" CRTL+PRNT (and no other hotkey)
***PREFERENCES > OUTPUT: define a folder at "Storage location" and a standard file type (default is *.png)
***PREFERENCES > DESTINATION: (reg's settings)
****- turn off "Select destination dymnamically"
****- open in image editor
****- copy to clipboard
**Usage:
***press Hotkey and make Screenshot
***paste immediately anywhere OR
***work on it inside Greenshot (give red circles or mark up in any colour), give numbers, obfuscate and more
***save or save as jpg or print

== Compiling ==

if you have an error with "Glyphs.xaml", than make sure you have copied \Resources MANUALLY into the output folders - this was changed in 2015. The output folder depends on compiling method "Debug" or "Release", it is
*for DEBUG _: (YourRepositoryFolder)\Mainline\bin\'''Debug\Resources''' or
*for RELEASE: (YourRepositoryFolder)\Mainline\bin\'''Release\Resources'''

it's creating:
*1> Supremacy.Scripting -> %path_repo%\bin\Debug\lib\Supremacy.Scripting.dll
*2> SupremacyCore -> %path_repo%\bin\Debug\lib\SupremacyCore.dll
*3> Supremacy.Xna -> %path_repo%\bin\Debug\lib\Supremacy.Xna.dll
*4> SupremacyClientComponents -> %path_repo%\bin\Debug\lib\SupremacyClientComponents.dll
*5> SupremacyWPF -> %path_repo%\bin\Debug\lib\SupremacyWPF.dll
*6> SupremacyService -> %path_repo%\bin\Debug\lib\SupremacyService.dll
*7> SupremacyUI -> %path_repo%\bin\Debug\lib\SupremacyUI.dll

== Visual C# ==

build in Visual Studio

<img>http://botf2.square7.ch/wiki-files/images/VS2015.jpg</img>

== SunBurn ==

SunBurn is on hold for now. Kenneth was working sometimes with SunBurn...this might be a site for this http://channel9.msdn.com/coding4fun/blog/No-need-for-sunscreen-you-want-this-SunBurn-SunBurn-v2-RTMs-including-the-free-SunBurn-Framework-Edi

*http://en.wikipedia.org/wiki/List_of_game_engines

== .Net ==

you should use latest [http://www.microsoft.com/net .Net-version] (2014: version 4.5.1)

== XNA ==

"Could not load file or assembly 'Microsoft.Xna.Framework.dll' or one of its dependencies. The specified module could not be found."

*suggestion by reg: go to \Resources\Models and rename the "Models"-folder to "Models-SetOffline" or something else (if building a ship no model is shown -as it is to most of the ships- but otherwise the game could work fine)

This suggests the problem is with your XNA installation. The game uses XNA to display the 3D ship models in the shipyard. There's no way to disable the models so XNA wouldn't be needed. So to be able to play the game, i'd advise to uninstall XNA, then install the latest version.

XNA 3.1 (this one you need in any case): http://www.microsoft.com/en-us/download/details.aspx?id=15163

XNA 4.0 Download link: http://www.microsoft.com/en-gb/download/details.aspx?id=20914

== Try ==

(for boolean)

try
{
return true;
}
catch (Exception e)
{
var errors = new System.Collections.Concurrent.ConcurrentStack<Exception>();
errors.Push(e);
return false;
}
finally
{
xxx;
}
;

== Contexts ==

*AppContext (programm running)
*GameContext.Current (Game started - so after StartScreen)
*PlayerContext.Current

== Text ==
=== en.txt ===
* XAML example: Text="{s:StringResource EMPIRES_HEADER}"
* string _text = String.Format(ResourceManager.GetString("KEY_IN-EN_TXT"),parameter1, parameter2;

== LocalPlayer ==

*AppContext.LocalPlayer (just inside XAML-code files ??)
* _appContext.LocalPlayer.Empire

== Civilization ==

just the data out of Civilization.xml ... for more see [[#CivilizationManager]]

== CivilizationManager ==

CivilizationManager holds all the data like amount of credits, diplomacy, sitreps and more

*GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

== GameLog ==

if not available, try "Quick actions" -> using Supremacy.Utility;

GameLog.Core.GameData.DebugFormat("Turn {0};xx=;{1};xx=;{2};xx={3};xx={4};xx={5};xx={6};xx={7};xx={8};xx={9};"
, GameContext.Current.TurnNumber
, xx
, xx
);

== Dictionary ==

private static Dictionary<string, bool> _acceptRejectDictionary = new Dictionary<string, bool> { { "98", false } };

== MessageBox (Windows Style) ==

MessageBox.Show("Borg turned into Expanded", "WARNING", MessageBoxButton.OK);

== MessageDialog (Supremacy Style) ==

var result = MessageDialog.Show("Borg turned into Expanded", MessageDialogButtons.YesNo);

== SoundPlaying ==

* _soundPlayer.PlayFile("Resources/SoundFX/ChatMessage.wav");

Source Code

2021-04-11T13:24:05Z

Reginald: /* LocalPlayer */

== Source Code ==

http://guganeshan.com/blog/setting-up-git-and-tortoisegit-with-bitbucket-step-by-step.html

=== official ===

* code is now at https://github.com/BotF2/BotF2.git

*last source code https://bitbucket.org/mstrobel/supremacy/overview (it's in C#, also named CSharp. [[#Visual Studio]] is used for coding.)
**Mike's Post: build in [http://www.microsoft.com/downloads/dlx/en-us/ThankYou.aspx?FamilyID=75568AA6-8107-475D-948A-EF22627E57A5 VS2010] with .NET 4.0. You may need the [http://en.csharp-online.net/Download_Free_Microsoft_Visual_CSharp_.NET#Download_Microsoft_Visual_Studio_Async_Community_Technology_Preview_.28CTP.29 C# Async CTP]. http://bote2.square7.ch/forum/viewtopic.php?p=70790#p70790
**http://bote2.square7.ch/forum/viewtopic.php?p=70781#p70781
*** Supremacy.Game.GameEngine is where you'll find most of the game logic. That's where most of the turn processing happens.
*** The SupremacyCore project is where you'll find the foundation of the game.
*** SupremacyService is just the game server (all the important bits it interacts with are in SupremacyCore).
*** SupremacyClientComponents is UI infrastructure.
*** SupremacyUI and SupremacyWPF are older UI infrastructure stuff, much of which has been phased out and replaced by newer and better stuff in SupremacyClientComponents. The most interesting stuff in SupremacyUI is GalaxyGridPanel, which draws the galactic map. It also has the spinning planet views.
*** Supremacy.Xna is where the XNA/3D stuff is located--it's not used heavily yet, but it has some effects for the invasion screen, a newer star renderer, a 3D spinning ship renderer, etc.
*** Supremacy.Scripting is an expression language parser/compiler.
*** SupremacyClient is the main graphical client and has most of the game screen implementations.

*old source code can be taken from here: http://supremacy.codeplex.com/ (last upload from MStrobel at 03.01.2011)

==== ClientContext vs AppContext ====

taken from https://bitbucket.org/kflanagan/supremacydev/commits/0d562ce676425cd5da19cfdbcf1b6c18c7d0d135

*IClientContext is used by SupremacyCore to interface clients participating on a game, both local and over network. The IClientContext further includes an interface to IGameContext which gives access to the game data itself inside the '''SupremacyClient app'''
*However there should be an option to also include local properties not known to the Core, which is why this is done alternatively another context would have to be introduced for local data, but then still all the client code would have to be updated to make use of it

==== .XAML files ====

In Windows Presentation Foundation (WPF), a windows app framework used by Supremacy, XAML forms a user interface markup language to define UI elements, data binding, events, and other features.

Info resources:

*MS Article: [https://msdn.microsoft.com/en-us/library/ms745683(v=vs.110).aspx XAML Styling and Templating]

*Youtube video: [https://www.youtube.com/watch?v=0qE5hyuU9hE Introduction to XAML] (26min)

== Bitbucket ==

*https://confluence.atlassian.com/display/BITBUCKET/Maintaining+a+Mercurial+Repository

== Changes ==

see [[ChangeLog|here]] or https://bitbucket.org/mstrobel/supremacy/commits/branch/default

=== 2016 ===

==== XAML ====

*January 2016 [Planned]: Hope to get Major Race specific UI build through use of generic XAML files.
* ClientApp.xaml.cs has the code to direct UI to race specific folders of xaml files in SupremacyClient/themes/{0}

Looking at SystemScreen.xaml, Global.xaml and ClientModules.cs in Themes/SupremacyClient
See also generic.xaml in SupremacyClientComponents/Themes/InfoCard Theme.xaml Default.xaml Icons.xaml ClientApp.xaml.cs SystemScreen.xaml

1/17/16: Found that Mikes code in ClientApp.xaml.cs will already select for Major race. Need new folders for each major race in SupremacyClient/themes/(major race), edit paths to Resources in the .xaml files found in each races set of .xaml files. File names in SupremacyClient/themes/(major race) are not unique but content in Resources is. Now you can edit files in Resources for unique UI.

2/13/16:

<Polygon
Points="300,200 400,125 400,275 300,200"
Stroke="Purple"
StrokeThickness="2">
<Polygon.Fill>
<SolidColorBrush Color="Blue" Opacity="0.4"/>
</Polygon.Fill>
</Polygon>

Makes a left pointing triangle, purple outline and blue body

=== 2015 ===

*'''Animation.cs''' (animation of opening screen): This is where we can set the number of images, frames, and the rate they play at, currently all images in 30 seconds. We may want that to run faster. The images you will make for the ship de-cloaking will be located in Resources / Images / Animation.
* \supremacyclient\'''ClientModule.cs''':
**Found a place to add the right mouse click instructions for the Panel Access Menu. A thing called the statusWindow held the text "loading" while you wait for a game to load. Added the information there for new players

*FMOD is partly replace by AudioEngine.cs and others - just find it out

=== 2014 ===

== some code ==

for Theme and UI see >> '''[[Theme]]'''

=== miscellaneous ===

*Mainline\SupremacyClient\GameContextMenu.cs

*\Mainline\SupremacyUI\SystemProductionPanel.cs

*\Mainline\SupremacyCore\Orbitals\FleetOrders.cs -> all items inside a sector

*Mainline\SupremacyClient\GameContextMenu.cs (Access Popup Menu - or use F1 to F5)

*\Mainline\SupremacyClientComponents\Controls\InfoCard\InfoCard.cs (-> Tooltips ??)
**\Mainline\SupremacyClient\themes\Federation\InfoCard.xaml -> <Setter Property="Width" Value="500" /> (BEFORE: 250)

*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyPlanetaryBuildQueueView.xaml - Colonies Screen Content

*\Mainline\SupremacyCore\Universe\Colony.cs
*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyStructureListView.xaml
**Size of this area: 720 x 240

*\Mainline\SupremacyClient\Views\GalaxyScreen\TaskForceListView.xaml

=== Version Number ===

Look for version number control in AssemblyInfo.cs

your hard disk code folder BotF2\SupremacyClient\Properties\AssemblyInfo.cs

---
example code: (put in your current star date)

*[assembly: AssemblyVersion("2018.11.20.0")]
*[assembly: AssemblyFileVersion("2018.11.20.0")]

=== Ships ===

*\Fleets.cs
*\FleetOrder.cs (without a "s" - beware of it)
*\FleetOrders.cs

*\mainline\supremacyclientcomponents\views\galaxyscreen\galaxyscreenpresenter.cs TaskForcesList

==== Building Ships ====

*Cancelling -> Breakpoint at Line 185 at OnShipyardBuildProjectsChanged() \Mainline\SupremacyClientComponents\Views\ColonyScreen\ColonyScreenPresentationModel.cs

=== Sounds ===

*\Mainline\SupremacyClient\AudioEngine.cs (for Music), for Sounds >> SoundPlayerAction is used (search for \Resources\UI\Federation\SoundsButtonClick.wav)
*and in \Mainline\SupremacyClientComponents\Views\SystemAssaultScreen\SystemAssaultScreenViewModel.cs -> Uri is used (e.g. CombatLaser.wav)

=== Galaxy Generator ===

*\Mainline\SupremacyCore\Universe\GalaxyGenerator.cs

=== Values ===
*CivID: 0 = Federation...

=== TurnPhase ===

WaitOnPlayers = 0,
PreTurnOperations,
ResetObjects,
FleetMovement,
Combat,
PopulationGrowth,
PersonnelTraining,
Research,
Scrapping,
Maintenance,
ShipProduction,
Production,
Trade,
Morale,
MapUpdates,
PostTurnOperations,
SendUpdates,
Diplomacy,
WaitOnAIPlayers

=== older list ===

{|class="wikitable sortable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |where
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Folder
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |File
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Function
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Date
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Description
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameContext.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
initialising game
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|
Raw Materials, Deuterium, Dilithium is collected cross over all colonies and used by all colonies
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoShipProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|

|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Combat
|style=text-align:center|InvasionArena.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
SystemAssault
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Orbital
|style=text-align:center|Shipyard.cs
|style=text-align:center|GetBuildOutput(int slot)
|style=text-align:center| [https://bitbucket.org/Bloodwurm/BotF2dev/commits/1aafc8f6e47e9e3b9c20de79f2d02f197c023d63 2014-01-15]
|style=text-align:left|
just selects output (active?) and bonus (BonusType.PercentShipBuilding), since 2014-01-15 also case PopulationRatio or IndustryRatio
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|GetProductionOutput(ProductionCategory category)
|style=text-align:center|
|style=text-align:left|
see last line, too !
*Food: minimum 10
*Research:
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*Industry: '''minimum 10 !'''
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*last line: return ((int)(baseOutput + (baseOutput * modifier.Efficiency)) + modifier.Bonus);
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasFoodBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasFoodBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasEnergyBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasEnergyBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-ClientComp
|style=text-align:center|Views\GalaxyScreen
|style=text-align:center|GalaxyScreenView.cs
|style=text-align:center|GalaxyScreenView()
|style=text-align:center|
|style=text-align:left|GalaxyView Hotkeys Definition (see [[Hotkey]]s)
|style=text-align:left|
|style=text-align:left|

|}

== Botf2-coding-practice ==

*http://star-trek-supremacy.proboards.com/thread/349/botf2-coding-practice (intern)

*prepare:
**...we are using SourceTree, provided by bitbucket (another option: TortoiseHg with Mercurial - to access the supremacy code repository http://tortoisehg.bitbucket.org/)
**PuTTYgen - to generate a ssh key to allow using ssh protocol instead of slow https http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
***or use C:\Program Files (x86)\Atlassian\SourceTree\tools\putty..puttygen.exe....generate a key (using a phrase is not neccessary)
***copy the public key (4-5 lines) into your bitbucket account/profile under SSH Keys, label it with any title and CopyPaste
**we are using Visual Studio Community 2013 Update 4 (select the Community Version) https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
**we are not(!) using Visual Studio Community 2015 RC - to compile the code (ISO is recommend)....still need to check if Supremacy code compiles with it, so instead we might need to depend on VS2013 http://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs....for VS 2015 we read to create a new project, import Supremacy and go through all the issues
**you also need to have an account on http://bitbucket.org
**and you should have Skype installed to participate in the meetings we have

*when you attempt to clone by ssh instead of https, check the following tutorial: http://confluence.atlassian.com/display/BITBUCKET/Set+up+SSH+for+Mercurial

*here some simple text editors useful to edit stuff like xml files, just pick the one you prefer they all are great:
**http://www.sublimetext.com/
**http://www.contexteditor.org/index.php
**http://notepad-plus-plus.org/ (used by reg atm)

== SourceTree ==

*Download >> https://www.sourcetreeapp.com/?v=win (or while cloning...use the link below blue Clone Button)

*Tools: 3rd point: OPTIONS

*SSH Client Configuration:
**SSH Key: c:\....\ReginaldPutty.ppk
**SSH Client: (IMPORTANT) PuTTY/Link (not SSH !!)
**automatically start: yes

== Visual Studio ==

It's possible (and standard) to compile the game with Visual Studio. No further stuff of programs is needed, except matching Resources folder. Mention that the compiled exe is then in \Mainline\bin\Debug (or \Release).

=== VS2019 ===

* meanwhile we are on VS 2019 Community version https://www.visualstudio.com/downloads

* see hints for VS 2017 especially >> Set as Start Project > SupremacyClient (View SolutionExplorer > SupremacyClient > right mouse click ...in the middle)

=== VS2017 ===

In May 2017 we're trying to change to VS 2017 Community version https://www.visualstudio.com/downloads

*you might want to change language at TOOLS > OPTIONS > ENVIROMENT > INTERNATIONAL SETTINGS

* first make a clean !!, maybe for each single project (10 of 10)

* SOLUTION EXPLORER - right mouse click - retarget (in the middle) - select newest versions

* (this should be only needed once and should be uploaded to Repository by one guy) SupremacyClient > Set as start Project

*after cleaning maybe use REBUILD

for more see >> [[#Tools|here]]

=== VS2015 ===

since April 2016 we're using VS 2015

*Visual Studio '''Community''' 2015 RC - to compile the code (ISO is recommend) ... still need to check if Supremacy code compiles with it, so instead we might need VS2013. NEW: we try to go to VS 2015 now.
https://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs - you need the "Community" Version, currently (Apr 2016) version "Update 2"

==== VS 2015 Update 3 ====

*says it does uninstall Update 2
*needs update to 33 GB to install (only if every is selected) - seems to need some hours...

=== old VS ===

this is out of date due to code has changed

==== Visual C++ Library ====

IMPORTANT: As Microsoft no longer provides Visual C++ Library as standard installed component ...don't forget to select or install this manually! In VS you can recognize it if \Supremacy Native is unload (sign is greyed out a little bit)

===== SupremacyNative =====

SupremacyNative is C++ coded. Sometimes there are some problems with it https://developercommunity.visualstudio.com/content/problem/312852/internal-compiler-error-in-vs158-msc1cpp-line-1518.html

*Visual Studio Community 2013 (Community version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2012 (Express version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2008 (German) http://www.microsoft.com/de-de/download/details.aspx?id=13276

=== Tools ===

*Indent Guides https://visualstudiogallery.msdn.microsoft.com/e792686d-542b-474a-8c55-630980e72c30 Adds vertical lines at each indent level.

* Vertical tabs https://marketplace.visualstudio.com/items?itemName=VisualStudioProductTeam.ProductivityPowerPack2017

*PowerShell Tools für VS 2015

=== Tips ===
*TOOLS > OPTIONS > ENVIRONMENT > Color theme -> Black

*TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Detect when file is changed outside... -> Yes
**TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Reload modified files... -> Yes

*DEBUG > OPTIONS > PROJECTS... > BUILD AND RUN > when code=project is changed="out of date" > "Always Build" (checkbox "only build ...on Run" is marked)
**https://www.vb-paradise.de/index.php/Thread/47935-Code-bei-Klick-auf-Debugging-starten-kompilieren-wenn-er-sich-ge%C3%A4ndert-hat/

*TOOLS > OPTIONS > TEXT EDITOR > ALL LANGUAGES > Line Number (activate for all)

*DEBUG > SUPREMACY CLIENT PROPERTIES (last) > DEBUG > Start project > Command line arguments: "-aiexplore -SAVEDGAME:auto" (if you save in Supremacy manually a game with name "auto" (independent from game's "(autosave)", this manually saved game can be loaded at startup.
**"-aiexplore" isn't necessary. For more see [[Command line parameter]]
**if working for example on Cardassian UI just save Cardassian as "auto".
**when you want to change to Klingons, just retire and start Klingons. If you want to work steady on Klingons, save a Klingon's game with auto.
**if you want to start a new game steady, just go Command line arguments (see above) and change the filename to an unused one like "-SAVEDGAME:auto123"

*activate Toolbar BUILD by right mouse click on Toolbar line

* Tools -> Options -> Debugging -> Output Window -> Module Load Messages -> Off

==== Editor ====
we're using some different editors
*one option is to drag'n'drop files like xml to Visual Studio
*sometimes we use Notepad++ https://notepad-plus-plus.org/download with Extension Compare (PLUGINS > PLUGIN MANAGER > SHOW P-Manager > "Compare" ...install
*for a black style we use Sublime http://www.sublimetext.com/2

==== Screenshot ====

*reg likes Greenshot http://getgreenshot.org/
**puts an icon into task bar. There: > PREFERENCES
***PREFERENCES > GENERAL: reg uses for "Capture region" CRTL+PRNT (and no other hotkey)
***PREFERENCES > OUTPUT: define a folder at "Storage location" and a standard file type (default is *.png)
***PREFERENCES > DESTINATION: (reg's settings)
****- turn off "Select destination dymnamically"
****- open in image editor
****- copy to clipboard
**Usage:
***press Hotkey and make Screenshot
***paste immediately anywhere OR
***work on it inside Greenshot (give red circles or mark up in any colour), give numbers, obfuscate and more
***save or save as jpg or print

== Compiling ==

if you have an error with "Glyphs.xaml", than make sure you have copied \Resources MANUALLY into the output folders - this was changed in 2015. The output folder depends on compiling method "Debug" or "Release", it is
*for DEBUG _: (YourRepositoryFolder)\Mainline\bin\'''Debug\Resources''' or
*for RELEASE: (YourRepositoryFolder)\Mainline\bin\'''Release\Resources'''

it's creating:
*1> Supremacy.Scripting -> %path_repo%\bin\Debug\lib\Supremacy.Scripting.dll
*2> SupremacyCore -> %path_repo%\bin\Debug\lib\SupremacyCore.dll
*3> Supremacy.Xna -> %path_repo%\bin\Debug\lib\Supremacy.Xna.dll
*4> SupremacyClientComponents -> %path_repo%\bin\Debug\lib\SupremacyClientComponents.dll
*5> SupremacyWPF -> %path_repo%\bin\Debug\lib\SupremacyWPF.dll
*6> SupremacyService -> %path_repo%\bin\Debug\lib\SupremacyService.dll
*7> SupremacyUI -> %path_repo%\bin\Debug\lib\SupremacyUI.dll

== Visual C# ==

build in Visual Studio

<img>http://botf2.square7.ch/wiki-files/images/VS2015.jpg</img>

== SunBurn ==

SunBurn is on hold for now. Kenneth was working sometimes with SunBurn...this might be a site for this http://channel9.msdn.com/coding4fun/blog/No-need-for-sunscreen-you-want-this-SunBurn-SunBurn-v2-RTMs-including-the-free-SunBurn-Framework-Edi

*http://en.wikipedia.org/wiki/List_of_game_engines

== .Net ==

you should use latest [http://www.microsoft.com/net .Net-version] (2014: version 4.5.1)

== XNA ==

"Could not load file or assembly 'Microsoft.Xna.Framework.dll' or one of its dependencies. The specified module could not be found."

*suggestion by reg: go to \Resources\Models and rename the "Models"-folder to "Models-SetOffline" or something else (if building a ship no model is shown -as it is to most of the ships- but otherwise the game could work fine)

This suggests the problem is with your XNA installation. The game uses XNA to display the 3D ship models in the shipyard. There's no way to disable the models so XNA wouldn't be needed. So to be able to play the game, i'd advise to uninstall XNA, then install the latest version.

XNA 3.1 (this one you need in any case): http://www.microsoft.com/en-us/download/details.aspx?id=15163

XNA 4.0 Download link: http://www.microsoft.com/en-gb/download/details.aspx?id=20914

== Try ==

(for boolean)

try
{
return true;
}
catch (Exception e)
{
var errors = new System.Collections.Concurrent.ConcurrentStack<Exception>();
errors.Push(e);
return false;
}
finally
{
xxx;
}
;

== Contexts ==

*AppContext (programm running)
*GameContext.Current (Game started - so after StartScreen)
*PlayerContext.Current

== Text ==
=== en.txt ===
* XAML example: Text="{s:StringResource EMPIRES_HEADER}"
* string _text = String.Format(ResourceManager.GetString("KEY_IN-EN_TXT"),parameter1, parameter2;

== LocalPlayer ==

*AppContext.LocalPlayer (just inside XAML-code files ??)
* _appContext.LocalPlayer.Empire

== Civilization ==

just the data out of Civilization.xml ... for more see [[#CivilizationManager]]

== CivilizationManager ==

CivilizationManager holds all the data like amount of credits, diplomacy, sitreps and more

*GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

== GameLog ==

if not available, try "Quick actions" -> using Supremacy.Utility;

GameLog.Core.GameData.DebugFormat("Turn {0};xx=;{1};xx=;{2};xx={3};xx={4};xx={5};xx={6};xx={7};xx={8};xx={9};"
, GameContext.Current.TurnNumber
, xx
, xx
);

== Dictionary ==

private static Dictionary<string, bool> _acceptRejectDictionary = new Dictionary<string, bool> { { "98", false } };

== MessageBox (Windows Style) ==

MessageBox.Show("Borg turned into Expanded", "WARNING", MessageBoxButton.OK);

== MessageDialog (Supremacy Style) ==

var result = MessageDialog.Show("Borg turned into Expanded", MessageDialogButtons.YesNo);

== SoundPlaying ==

* _soundPlayer.PlayFile("Resources/SoundFX/ChatMessage.wav");

Ships

2021-04-03T15:27:19Z

Reginald: /* Experience */

= Intro =

...not completed yet...

Basics please see [[Manual#MILITARY button|Manual]]

= Ship's Values =

please see [http://botf2.square7.ch/b2_db/Ships.php BotF2-DB]

== PopulationHealth ==

one part (only one?) see [[Planet#Population Health]]

= Ship's Status =

please see [[Manual#Ship's Status|Manual]]

for game-inside details use deployment and mark the ship you want to see details of it (e.g. crew experiance)

== Renaming ==

please see [[Manual#RENAMING|Manual]]

== Shield ==

please see [[Manual#Ship's Status|Manual]]

== Hull ==

please see [[Manual#Ship's Status|Manual]]

==== Hull repair ====

*see in code: \Mainline\SupremacyCore\Orbitals\Orbital.cs -> private void RegenerateHull()
**1.0% in hostile systems 1% (increase = 0.01;)
**2.5% in claimed territory 2,5 % (if (claimingCiv == this.Owner)...increase = 0.025;)
**5.0% in a sector with an owned starbase (if (Sector.Station != null)...increase = 0.05;)
**10.0% at an owned colony (increase = 0.10;)
Only the highest option is chosen.

== Deuterium ==

please see [[Manual#Ship's Status|Manual]] and [[Deuterium]]

= Order =

please see [[Manual#Ship's Orders|Manual]]

== FleetOrders.cs ==

public static readonly EngageOrder EngageOrder;
public static readonly AvoidOrder AvoidOrder;
public static readonly ColonizeOrder ColonizeOrder;
public static readonly TowOrder TowOrder;
public static readonly CollectDeuteriumOrder CollectDeuteriumOrder;
//public static readonly EscortOrder EscortOrder;
public static readonly BuildStationOrder BuildStationOrder;
public static readonly ExploreOrder ExploreOrder;
public static readonly AssaultSystemOrder AssaultSystemOrder;

== Escort ==

*disabled https://bitbucket.org/mstrobel/supremacy/issue/322/escort-functionality (issue/322)

== Train Crew ==

not part of BotF2, but of Supremacy (see http://www.armadafleetcommand.com/onscreen/botf/viewtopic.php?p=43880#p43880)

you can only train the crew if the ship/fleet is orbiting a system with an "academy" building (SF Academy, Naval Academy, etc). Notice the Dominion doesn't have such a building. Some minors' special building are academies, like the Andorians, Zakdorn, etc.

Ships built in systems with academies start as Regular, and Klingon crews always start with a minimum of 350XP (half the Regular threshold).

BTW, crews are not yet gaining [[#Experience|experience]] from battles. I'll try to address that soon.

= Range =

see this discussion https://bitbucket.org/mstrobel/supremacy/issue/125/shipyard-fuel-range

= Stranded =

*Stranded Ships can not retreat https://bitbucket.org/mstrobel/supremacy/issue/219/stranded-ships-can-retreat

= Combat =

please see [[Manual#Combat|Manual]]

== Damage in Combat ==

*https://bitbucket.org/mstrobel/supremacy/issue/368/damage-control (issue/368)

== IsBattleFleet ==

*Fleet.cs Line 310: All ships are BattleFleet without: Scout, Colony, Construction, Medical, Science, Transport

== NonCombatant ==

*ShipClass.cs Line 19:
**Colony = 0,
**Construction,
**Transport,
**Medical

= Deployment =

please see [[Manual#Task Force Deployment|Manual]]

= System Assault =

please see [[Manual#System Assault|Manual]]

*https://bitbucket.org/mstrobel/supremacy/issue/362/bypassing-obs (issue/362) ( "extra" round of combat between the OBs and the fleet?)

*https://bitbucket.org/mstrobel/supremacy/issue/363/invasion-by-destroyed-fleets (issue/363)

= Types of Ships =

*The SHIPLISTS and NEW SHIP INFO (now Updated) http://www.botf2.star-trek-games.com/viewtopic.php?f=11&t=1066 (search entry t=1066)

*especially http://www.botf2.star-trek-games.com/viewtopic.php?p=27152#p27152

Links:
* BotF at Memory Beta http://memory-beta.wikia.com/wiki/Birth_of_the_Federation
* Alien Ship Database at [http://www.neutralzone.de/database/Alien/index.html www.neutralzone.de]
* [http://www.staryards.com/Downloads/Ships/Other/other_ships.htm Staryards.com] (last entry 2008)
* http://www.moddb.com/mods/foc-alliance-star-trek-tos/images (Kenneth)

== Plans ==

*Spy ships -> Infiltrate = get info about the whole spied civilization (don't know yet, but maybe get SystemView by double clicking their sectors for seeing their facilities and structures)
**after spying the ship is destroyed (similar to colony ships). The reason is that a spy ship flies there, agents (=work capacity) integrate into the foreign race and even the ship can't be used for another civilization)

= Major Ships =

see [[TechObjectDatabase.xml]] and [[TextDatabase.xml]]

{|class="wikitable sortable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Type/Table
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Images
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Status
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Issues
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Comment
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:left|Table: [[Colony Ship]]s
|style=text-align:left|[[Ship Images#Colony_Ships]]
|style=text-align:center|
|style=text-align:left|Colony Ships are for colonizing (terraforming isn't implemented yet).
|style=text-align:left|
|style=text-align:left|
|style=text-align:right|
|style=text-align:left|

|-
|style=text-align:left|Table: [[Transport Ship]]s
|style=text-align:left|[[Ship Images#Transport Ships]]
|style=text-align:center|
|style=text-align:left|
Transport ships are for building [[Station]]s and for [[System Assault]]. Don't know whether there are some transport tasks.
|style=text-align:left|
|style=text-align:left|
|style=text-align:right|
|style=text-align:left|

|-
|style=text-align:left|Table: [[Medical Ship]]s
|style=text-align:left|[[Ship Images#Medical Ships]]
|style=text-align:center|
|style=text-align:left|
Medical ships are for spending health to other ships (maybe not implemented yet)[[Medical_Ship|see here]]
|style=text-align:left|
|style=text-align:left|
|style=text-align:right|
|style=text-align:left|

|-
|style=text-align:left|Table: [[Scout Ship]]s
|style=text-align:left|[[Ship Images#Scouts]]
|style=text-align:center|
|style=text-align:left|
Scouts are for scouting
|style=text-align:left|
|style=text-align:left|
|style=text-align:right|
|style=text-align:left|

|-
|style=text-align:left|Table: [[Science Ship]]s
|style=text-align:left|[[Ship Images#Science Ships]]
|style=text-align:center|
|style=text-align:left|
Science ships are
|style=text-align:left|
|style=text-align:left|
|style=text-align:right|
|style=text-align:left|

|-
|style=text-align:left|Table: [[Construction Ship]]s
|style=text-align:left|[[Ship Images#Construction Ships]]
|style=text-align:center|
|style=text-align:left|
Construction ships are for building [[station]]s for expand the ship's range
|style=text-align:left|
|style=text-align:left|
|style=text-align:right|
|style=text-align:left|

|-
|style=text-align:left|Table: [[Frigate]]
|style=text-align:left|[[Ship Images#Frigate]]
|style=text-align:center|
|style=text-align:left|
Frigate ships are
|style=text-align:left|
|style=text-align:left|
|style=text-align:right|
|style=text-align:left|

|-
|style=text-align:left|Table: [[Cruiser]]
|style=text-align:left|[[Ship Images#Cruiser]]
|style=text-align:center|
|style=text-align:left|
Cruiser ships are for
|style=text-align:left|
|style=text-align:left|also Strike Cruiser and Tactical Cruiser
|style=text-align:right|
|style=text-align:left|

|-
|style=text-align:left|Table: [[Destroyer]]
|style=text-align:left|[[Ship Images#Destroyer]]
|style=text-align:center|
|style=text-align:left|
Destroyer ships are for
|style=text-align:left|
|style=text-align:left|also Heavy Destroyer
|style=text-align:right|
|style=text-align:left|

|-
|style=text-align:left|Table: [[Command Ship]]
|style=text-align:left|[[Ship Images#Command Ships]]
|style=text-align:center|
|style=text-align:left|
Command ships are for
|style=text-align:left|
|style=text-align:left|
|style=text-align:right|
|style=text-align:left|

|}

== old lists ==

see [[Ships (old lists)]]

= Experience =

at the moment: Moving = 5 points, staying = 1 point, max = 10000 points

*https://bitbucket.org/mstrobel/supremacy/issue/31/starting-crew-xp
**Ships built when an academy (Starfleet Academy, Naval Academy etc) is built and powered are not starting as having a Regular crew (700 XP) like in BotF

Experience Rank: see table below

*Buildings PercentShipExperience: [http://botf2.square7.ch/b2_db/BuildingsPercentShipExperience.php Database-List]

see also [[#Train Crew]]

= Accuracy Modifier =

see table below

= Damage Control Modifiers =

Values defined in [[Table#ShipTables.txt|ShipTables.txt]]

{|class="wikitable sortable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Exp.Rank
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Image
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Exp.LowerBound
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |DamageControlModifiers
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |AccuracyModifiers
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Comment
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:center|Green
|style=text-align:center|
|style=text-align:center|0
|style=text-align:left|1.0
|style=text-align:left|0.5
|style=text-align:left|
|style=text-align:right|
|style=text-align:left|

|-
|style=text-align:center|Regular
|style=text-align:center|
|style=text-align:center|700
|style=text-align:left|0.9
|style=text-align:left|0.7
|style=text-align:left|
|style=text-align:right|
|style=text-align:left|

|-
|style=text-align:center|Veteran
|style=text-align:center|
|style=text-align:center|1500
|style=text-align:left|0.75
|style=text-align:left|0.8
|style=text-align:left|
|style=text-align:right|
|style=text-align:left|

|-
|style=text-align:center|Elite
|style=text-align:center|
|style=text-align:center|5000
|style=text-align:left|0.60
|style=text-align:left|0.9
|style=text-align:left|
|style=text-align:right|
|style=text-align:left|

|-
|style=text-align:center|Legendary
|style=text-align:center|
|style=text-align:center|8000
|style=text-align:left|0.25
|style=text-align:left|1.0
|style=text-align:left|
|style=text-align:right|
|style=text-align:left|

|}

= ShipBuilding =

see [[Shipyard]]

*Buildings:
**PercentShipBuilding: [http://botf2.square7.ch/b2_db/BuildingsPercentShipExperience.php Database-List]
**PercentScrapping: [http://botf2.square7.ch/b2_db/BuildingsPercentScrapping.php Database-List]
***https://bitbucket.org/mstrobel/supremacy/issue/238/percentscrapping-not-working (issue/238) [CLOSED]

== Rally point ==

*http://star-trek-supremacy.proboards.com/thread/343/ship-rally-points

= Population Support =

see [[Population#Population Support]]

= Minor =

they are part of [[:Category:Races|the special race sites]] (still under construction). See also [[Minor]]

no use yet:
{| align="left"|
|align="center"|[[Minor|Minor Axanar]]
|
|align="center"|[[Minor|Minor Coridan]]
|
|align="center"|[[Minor|Minor Kazon]]
|
|align="center"|[[Minor|Minor Tellarite]]

|-
|style="border:5px solid grey;padding:0.1em;padding-left:0.1em;" bgcolor="#000000"|<img size=200>http://botf2.square7.ch/wiki-files/images/TechObjects/Ships/axanar_shipyard.png</img>
|
|style="border:5px solid grey;padding:0.1em;padding-left:0.1em;" bgcolor="#000000"|<img size=200>http://botf2.square7.ch/wiki-files/images/TechObjects/Ships/coridan_shipyard.png</img>
|
|style="border:5px solid grey;padding:0.1em;padding-left:0.1em;" bgcolor="#000000"|<img size=200>http://botf2.square7.ch/wiki-files/images/TechObjects/Ships/kazon_shipyard.png</img>
|
|style="border:5px solid grey;padding:0.1em;padding-left:0.1em;" bgcolor="#000000"|<img size=200>http://botf2.square7.ch/wiki-files/images/TechObjects/Ships/tellarite_shipyard.png</img>

|}

= Type4Ships =

* BORG_CUBE_IV
* BORG_TACTICAL_CUBE_IV
* CARD_CRUISER_IV
* CARD_DESTROYER_IV
* DOM_CRUISER_IV
* DOM_DESTROYER_IV
* FED_CRUISER_IV
* KLING_CRUISER_IV
* KLING_DESTROYER_IV
* ROM_CRUISER_IV
* ROM_DESTROYER_IV
* TERRAN_CRUISER_IV

= Type5Ships =

* BORG_CUBE_V
* BORG_TACTICAL_CUBE_V
* FED_CRUISER_V
* TERRAN_CRUISER_V

[[Category:Ships]]

Screenshots

2021-02-06T13:57:35Z

Reginald: /* some pictures */

= some pictures =

*some more screenshots > sorry, http://www.startreksupremacy.com/screenshots.html is offline

== [[Start Game Panel]] ==
<img>http://botf2.square7.ch/wiki-files/images/self-explanatoryMenu.png</img>

== [[Galaxy Panel]] ==
<img size=957>http://botf2.square7.ch/wiki-files/images/_Screenshots/1---Galaxy/1---GalaxyPanel_Described.jpg</img>

== [[Embassy Panel]] ==
<img>http://botf2.square7.ch/wiki-files/images/EmbassyPanel.png</img>

== [[System Structures]] ==
<img>http://botf2.square7.ch/wiki-files/images/SystemStructuresScreen.png</img>

== [[System Production]] ==
<img>http://botf2.square7.ch/wiki-files/images/SystemSummary.png</img>

== ShipMovement ==
<img>http://botf2.square7.ch/wiki-files/images/ShipMovement.png</img>

== Combat ==

<div style="border:1px solid black;width:100%;overflow-y:hidden;overflow-x:scroll;background-color:#dadada; ">

{| class="infobox"
|valign="top" align="center" bgcolor="#fafaba"| Combat
|-
| bgcolor="#fafafa" - valign="top"|
<img>http://botf2.square7.ch/wiki-files/images/Combat.png</img>
|}

</div>

== System Assault ==

<div style="border:1px solid black;width:100%;overflow-y:hidden;overflow-x:scroll;background-color:#dadada; ">

{| class="infobox"
|valign="top" align="center" bgcolor="#fafaba"| System Assault
|-
| bgcolor="#fafafa" - valign="top"|
<img>http://botf2.square7.ch/wiki-files/images/SystemAssaultMenu.jpg</img>
|}

</div>

== alternativ Title.png ==

<div style="border:1px solid black;width:100%;overflow-y:hidden;overflow-x:scroll;background-color:#dadada; ">

{| class="infobox"
|valign="top" align="center" bgcolor="#fafaba"| Title by Captain Bashir
|-
| bgcolor="#fafafa" - valign="top"|
<img size=1280>http://botf2.square7.ch/wiki-files/images/Backgrounds/Title_Test.jpg</img>
|}

</div>

[[category:Screenshots]]

UI

2020-12-20T10:39:03Z

Reginald: /* Button */

== Intro ==

some words to UI....

* starting a game starts every of the five screens at the same time ! (Map/System/...)

* inside the screens it is mostly jumping to the last selected tab (e.g. System: Production or Shipbuilding)
** these complete screens are done by different parts:
***left top: Template like SystemInfo
***left bottom: Template like BuildQueue
***right: ProductionScreen
***right bottom: Planets...

== Theme ==

* Themes are appearance of each Empire's UI.

Common stuff is content of Global.xaml

Empire's themes are defined in Shared.xaml

=== Shared.xaml ===

Parts and Structure of each Shared.xaml could be (but is not ..take Klingons as an example, not the Federation sharing a lot of stuff with Global.xaml)

=== Border ===

* LCARS_BorderStyle (e.g. Chat-Window)
* LCARS_ThinBorderStyle (e.g. Summary)

=== Button ===

* GameButton - Templates: // e.g. Economy
** <Trigger Property="Context" Value="HorizontalGroupItem">
** <Trigger Property="DisplayMode" Value="GroupedHorizontally">
** <Trigger Property="DisplayMode" Value="GroupedVertically">
** <Trigger Property="Context" Value="VerticalGroupItem">
** <Trigger Property="DisplayMode" Value="CheckBox">
** <Trigger Property="DisplayMode" Value="Hyperlink">
** <Trigger Property="DisplayMode" Value="Minimal">
** <Trigger Property="DisplayMode" Value="Tiny">

* LCARS_BorderButtonStyle
* LCARS_BorderToggleButtonStyle" // e.g. CHAT Button in GalaxyMapView
* LCARS_SimpleButtonStyle // e.g. REDEPLOY-Button
* LCARS_SimpleToggleButtonStyle

* Default = IsEnable = Current Selection = GREEN = LCARS_Dom3Gradient_Bottom_Top
* MouseOver = PINK GRADIENT = LCARS_Dom2Gradient_Bottom_Top
* IsPressed = PINK = LCARS_Dom1Gradient_Bottom_Top
* IsChecked

=== TextBrush ===

Usage: {StaticResource HeaderTextBrush}
*DefaultTextBrush"
*HeaderTextBrush"
*LCARS_HeaderBrush"
*DisabledTextBrush"
*SelectionBrush"
*BorderBrush"

----

* ControlTextForegroundBrushKey

* HeaderTextForegroundBrushKey

* DefaultTextForegroundBrushKey

* ImageBorderBrushKey

* DisabledTextForegroundBrushKey

* HighlightBrushKey

* InactiveHighlightBrushKey

* AlertTextForegroundBrushKey

* HighlightBrushKey

== Colour ==

=== LightBlue ===
* Research
* Dilithium

=== Red ===
* Deuterium

=== Silver ===
* Intelligence

=== Gray ===
* Duranium = Rax Materials

=== Goldrod ===
* Energy
* Total Population in EmpireInfo

=== Borg ===

*LCARS_GreenTextBrush

*DarkGreen

== ClientApp ==

* SupremacyClient\ClientApp.xaml.cs - this is the main app - starting at "EntryPoint"
* SupremacyClient\ClientWindow.xaml.cs - this is the main window

== MultiplayerSetupScreen ==

* MultiplayerSetupScreen.xaml + MultiplayerSetupScreen.xaml.cs

== SUMMARY ==

SitReps are a part of CivManager of a Civilization...

* SitRepEntry.cs (contains a Global SitRep-Function and special ones)

* SitRepDialog.xaml ( = Dialog )
* SitRepDialog.xaml.cs ( Logic for Dialog = Filter on/off )

== Context Menu ==

* SupremacyClient\themes\Dominion\GameContextMenu.xaml
* GalaxyScreenView.xaml

== Bottom View ==

various parts are filled in

=== PlanetsViewRegion ===

* \SupremacyUI\StarSystemPanel.cs

=== AssignedShipListRegion ===

* AssignedShipListRegion

=== PART_ChatPanel ===

* PART_ChatPanel

== F1 ==

* GalaxyScreenView.xaml (Race specific)

* Expander EmpireInfo > EmpireInfoView.xaml

== F2 ==

=== Right ===

* SystemProductionPanel.cs (without any xaml file !)

=== Left ===

* ColonyHandlingListView.cs

== F3 ==

* NewDiplomacyScreen.xaml + NewDiplomacyScreen.xaml.cs
* DiplomacyScreenViewModel.cs
* \SupremacyCore\Diplomacy\DiplomacyHelper.cs
* DiplomatAI.cs
* ForeignPowerViewModel.cs

* DiplomacyMessageViewModel.cs and more

* AcceptProposalVisitor.cs
* RejectProposalVisitor.cs

== F4 ==

== F5 ==

* AssetsScreen.xaml + AssetsScreen.xaml.cs
** TAB: Colonies -> a) Headline directly in AssetsScreen.xaml
** TAB: Colonies -> b) ColonyList ="{Binding Path=Colonies} -> SystemListItem.xaml (+.cs)
*
** TAB: SpyReport -> b)

* AssetsScreenPresentationModel.cs

* ActiveAgreementViewModel.cs

== F11 ==

* File:CheatMenu.xaml + File:CheatMenu.xaml.cs

== CTRL+F11 ==

* FakeDialog.xaml + FakeDialog.xaml.cs

== ClientSettings ==

* ClientSettings.cs - stuff is written into file > ClientSettings.xaml

=== CTRL+O ===

* ClientOptionsDialog.xaml + ClientOptionsDialog.xaml.cs

==== File:ClientOptionsDialog.xaml ====

* File:ClientOptionsDialog.xaml

=== CTRL+Z ===

* ClientTracesDialog.xaml + ClientTracesDialog.xaml.cs

==== File:TracesOptionsPage.xaml ====

* File:TracesOptionsPage.xaml + File:TracesOptionsPage.xaml.cs

== GameOptionsPanel ==

at Starting

* GameOptionsPanel.xaml + GameOptionsPanel.xaml.cs

== LoadGameDialog ==

* LoadGameDialog.xaml.cs

* SavedGameHeader.cs ( Header checks the save game version if the file is compatible)

== Files ==

* ClientSettings.xaml

== Important Code Files ==

* ClientModule.cs ... starts the App and 'ends' at StartScreen..

* ClientOptions ... like Music Volume

* GameEngine.cs ... start for example a SinglePlayerGame or MultiPlayerGame
** Do....

* GameOptions like GalaxySize

* SupremacyCore\Game\CivilizationManager.cs ... handling Empires and other Civilizations

=== Sector ===
** contains a System, Nebulas are also a System
** a system might contain a Colony (which is a inhabitanted system)
** a colony might have Planets (and them moons)

* Colony.cs ... doing stuff for a single Colony

=== Civilization ===

* CivilizationManager.cs > contains the civilizations (current credits and more)
* Civilization.cs > only stuff from Civilization.xaml like Name

=== SAVELOAD ===

* SavedGameHeader.cs = Header (Name of saved file, version nummer (!!) and more)
* SavedGameManager.cs = saving Game

Resource

2020-12-13T10:38:14Z

Reginald: /* Dilithium */

= Intro =

[[Resource]]s like [[Duranium]] <img>http://botf2.square7.ch/wiki-files/images/Resources/rawmaterials.png</img> and [[Dilithium]] <img>http://botf2.square7.ch/wiki-files/images/Resources/dilithium.png</img> are desirable for ship construction. They are shown right beside the sun. (For other symbols see [[System#Symbols|here]])

[[Deuterium]] <img>http://botf2.square7.ch/wiki-files/images/Resources/deuterium.png</img> is another one.

*These resources will primarly used for local production in a system, but unused resources are given to the global stockpile.

*On the other side for system production resources out of global stockpile are used for local production.

*To avoid that one system get's an advantage or an disadvantage when global stockpile is low, system's sequence is shuffled (Algorithms.RandomShuffleInPlace(colonies)).

Later another resource will follow: [[Personnel]] <img>http://botf2.square7.ch/wiki-files/images/Resources/personnel.png</img>

Other resources are [[Food]] <img>http://botf2.square7.ch/wiki-files/images/Resources/food.png</img> and [[Energy]] <img>http://botf2.square7.ch/wiki-files/images/Resources/energy.png</img>

= Distribution =

*http://star-trek-supremacy.proboards.com/thread/342/resources-colonies

Raw Materials(Duranium), Deuterium, Dilithium is collected cross over all colonies and used by all colonies
*SupremacyCore\Game\GameEngine.cs void DoProduction(GameContext game)

for others (e.g. Food, Industry, Energy):
*SupremacyCore\Universe\Colony.cs

= Dilithium =

<img>http://botf2.square7.ch/wiki-files/images/Resources/dilithium.png</img>

*Buildings
**Dilithium: [http://botf2.square7.ch/b2_db/BuildingsDilithium.php Database-List]

*https://bitbucket.org/mstrobel/supremacy/issue/75/colonies-screen-3 (issue/75)

= Duranium =

<img>http://botf2.square7.ch/wiki-files/images/Resources/rawmaterials.png</img> Duranium -also called RawMaterials- ...

*Buildings
**RawMaterials + PercentRawMaterials: [http://botf2.square7.ch/b2_db/BuildingsRawMaterials.php Database-List]

==== FAQ Duranium ====
'''Q: How do I get more Duranium?'''

A: Systems with Asteroids can build a structure that mines additional Duranium. Some empires have structures that mine extra Duranium (Cardassians, Dominion). There's also a universal structure that allows a lot more Duranium to be mined, but with a huge Morale penalty (Core Mining Complex).

= Deuterium =

<img>http://botf2.square7.ch/wiki-files/images/Resources/deuterium.png</img>

*Buildings
**Deuterium + PercentDeuterium: [http://botf2.square7.ch/b2_db/BuildingsRawMaterials.php Database-List]

2018-08-12: Add missing Deuterium Extractor for some empires

= Personnel =

<img>http://botf2.square7.ch/wiki-files/images/Resources/personnel.png</img>

*Buildings (at the moment no such building available because Personnel isn't ingame at the moment)
**Personnel + PercentPersonnelLoyalty + PercentPersonnelTraining: [http://botf2.square7.ch/b2_db/BuildingsPersonnel.php Database-List]

= Food =

<img>http://botf2.square7.ch/wiki-files/images/Resources/food.png</img> see [[Food]]

*Buildings
**Food + PercentFood: [http://botf2.square7.ch/b2_db/BuildingsFood.php Database-List]

= Energy =

<img>http://botf2.square7.ch/wiki-files/images/Resources/energy.png</img>

*Buildings
**Energy + PercentEnergy: [http://botf2.square7.ch/b2_db/BuildingsEnergy.php Database-List]

== Energy shortage ==

*https://bitbucket.org/mstrobel/supremacy/issue/24/energy-shortages (issue/24): OBs are shut down last, power shortages should be most critical (and happen mostly) during bombardments, where OBs are more important. (Shipyards energy is also critical due to range extender)

UI

2020-12-06T12:39:17Z

Reginald: /* Theme */

== Intro ==

some words to UI....

* starting a game starts every of the five screens at the same time ! (Map/System/...)

* inside the screens it is mostly jumping to the last selected tab (e.g. System: Production or Shipbuilding)
** these complete screens are done by different parts:
***left top: Template like SystemInfo
***left bottom: Template like BuildQueue
***right: ProductionScreen
***right bottom: Planets...

== Theme ==

* Themes are appearance of each Empire's UI.

Common stuff is content of Global.xaml

Empire's themes are defined in Shared.xaml

=== Shared.xaml ===

Parts and Structure of each Shared.xaml could be (but is not ..take Klingons as an example, not the Federation sharing a lot of stuff with Global.xaml)

=== Border ===

* LCARS_BorderStyle (e.g. Chat-Window)
* LCARS_ThinBorderStyle (e.g. Summary)

=== Button ===

* GameButton // e.g. Economy
** Style
** Normal = just Text rectangle
** Tiny
**
* LCARS_BorderButtonStyle
* LCARS_BorderToggleButtonStyle" // e.g. CHAT Button in GalaxyMapView
* LCARS_SimpleButtonStyle // e.g. REDEPLOY-Button
* LCARS_SimpleToggleButtonStyle

* Default = IsEnable = Current Selection = GREEN = LCARS_Dom3Gradient_Bottom_Top
* MouseOver = PINK GRADIENT = LCARS_Dom2Gradient_Bottom_Top
* IsPressed = PINK = LCARS_Dom1Gradient_Bottom_Top
* IsChecked

=== TextBrush ===

Usage: {StaticResource HeaderTextBrush}
*DefaultTextBrush"
*HeaderTextBrush"
*LCARS_HeaderBrush"
*DisabledTextBrush"
*SelectionBrush"
*BorderBrush"

----

* ControlTextForegroundBrushKey

* HeaderTextForegroundBrushKey

* DefaultTextForegroundBrushKey

* ImageBorderBrushKey

* DisabledTextForegroundBrushKey

* HighlightBrushKey

* InactiveHighlightBrushKey

* AlertTextForegroundBrushKey

* HighlightBrushKey

== Colour ==

=== LightBlue ===
* Research
* Dilithium

=== Red ===
* Deuterium

=== Silver ===
* Intelligence

=== Gray ===
* Duranium = Rax Materials

=== Goldrod ===
* Energy
* Total Population in EmpireInfo

=== Borg ===

*LCARS_GreenTextBrush

*DarkGreen

== ClientApp ==

* SupremacyClient\ClientApp.xaml.cs - this is the main app - starting at "EntryPoint"
* SupremacyClient\ClientWindow.xaml.cs - this is the main window

== MultiplayerSetupScreen ==

* MultiplayerSetupScreen.xaml + MultiplayerSetupScreen.xaml.cs

== SUMMARY ==

SitReps are a part of CivManager of a Civilization...

* SitRepEntry.cs (contains a Global SitRep-Function and special ones)

* SitRepDialog.xaml ( = Dialog )
* SitRepDialog.xaml.cs ( Logic for Dialog = Filter on/off )

== Context Menu ==

* SupremacyClient\themes\Dominion\GameContextMenu.xaml
* GalaxyScreenView.xaml

== Bottom View ==

various parts are filled in

=== PlanetsViewRegion ===

* \SupremacyUI\StarSystemPanel.cs

=== AssignedShipListRegion ===

* AssignedShipListRegion

=== PART_ChatPanel ===

* PART_ChatPanel

== F1 ==

* GalaxyScreenView.xaml (Race specific)

* Expander EmpireInfo > EmpireInfoView.xaml

== F2 ==

=== Right ===

* SystemProductionPanel.cs (without any xaml file !)

=== Left ===

* ColonyHandlingListView.cs

== F3 ==

* NewDiplomacyScreen.xaml + NewDiplomacyScreen.xaml.cs
* DiplomacyScreenViewModel.cs
* \SupremacyCore\Diplomacy\DiplomacyHelper.cs
* DiplomatAI.cs
* ForeignPowerViewModel.cs

* DiplomacyMessageViewModel.cs and more

* AcceptProposalVisitor.cs
* RejectProposalVisitor.cs

== F4 ==

== F5 ==

* AssetsScreen.xaml + AssetsScreen.xaml.cs
** TAB: Colonies -> a) Headline directly in AssetsScreen.xaml
** TAB: Colonies -> b) ColonyList ="{Binding Path=Colonies} -> SystemListItem.xaml (+.cs)
*
** TAB: SpyReport -> b)

* AssetsScreenPresentationModel.cs

* ActiveAgreementViewModel.cs

== F11 ==

* File:CheatMenu.xaml + File:CheatMenu.xaml.cs

== CTRL+F11 ==

* FakeDialog.xaml + FakeDialog.xaml.cs

== ClientSettings ==

* ClientSettings.cs - stuff is written into file > ClientSettings.xaml

=== CTRL+O ===

* ClientOptionsDialog.xaml + ClientOptionsDialog.xaml.cs

==== File:ClientOptionsDialog.xaml ====

* File:ClientOptionsDialog.xaml

=== CTRL+Z ===

* ClientTracesDialog.xaml + ClientTracesDialog.xaml.cs

==== File:TracesOptionsPage.xaml ====

* File:TracesOptionsPage.xaml + File:TracesOptionsPage.xaml.cs

== GameOptionsPanel ==

at Starting

* GameOptionsPanel.xaml + GameOptionsPanel.xaml.cs

== LoadGameDialog ==

* LoadGameDialog.xaml.cs

* SavedGameHeader.cs ( Header checks the save game version if the file is compatible)

== Files ==

* ClientSettings.xaml

== Important Code Files ==

* ClientModule.cs ... starts the App and 'ends' at StartScreen..

* ClientOptions ... like Music Volume

* GameEngine.cs ... start for example a SinglePlayerGame or MultiPlayerGame
** Do....

* GameOptions like GalaxySize

* SupremacyCore\Game\CivilizationManager.cs ... handling Empires and other Civilizations

=== Sector ===
** contains a System, Nebulas are also a System
** a system might contain a Colony (which is a inhabitanted system)
** a colony might have Planets (and them moons)

* Colony.cs ... doing stuff for a single Colony

=== Civilization ===

* CivilizationManager.cs > contains the civilizations (current credits and more)
* Civilization.cs > only stuff from Civilization.xaml like Name

=== SAVELOAD ===

* SavedGameHeader.cs = Header (Name of saved file, version nummer (!!) and more)
* SavedGameManager.cs = saving Game

Source Code

2020-12-05T10:06:40Z

Reginald: /* Visual Studio */

== Source Code ==

http://guganeshan.com/blog/setting-up-git-and-tortoisegit-with-bitbucket-step-by-step.html

=== official ===

* code is now at https://github.com/BotF2/BotF2.git

*last source code https://bitbucket.org/mstrobel/supremacy/overview (it's in C#, also named CSharp. [[#Visual Studio]] is used for coding.)
**Mike's Post: build in [http://www.microsoft.com/downloads/dlx/en-us/ThankYou.aspx?FamilyID=75568AA6-8107-475D-948A-EF22627E57A5 VS2010] with .NET 4.0. You may need the [http://en.csharp-online.net/Download_Free_Microsoft_Visual_CSharp_.NET#Download_Microsoft_Visual_Studio_Async_Community_Technology_Preview_.28CTP.29 C# Async CTP]. http://bote2.square7.ch/forum/viewtopic.php?p=70790#p70790
**http://bote2.square7.ch/forum/viewtopic.php?p=70781#p70781
*** Supremacy.Game.GameEngine is where you'll find most of the game logic. That's where most of the turn processing happens.
*** The SupremacyCore project is where you'll find the foundation of the game.
*** SupremacyService is just the game server (all the important bits it interacts with are in SupremacyCore).
*** SupremacyClientComponents is UI infrastructure.
*** SupremacyUI and SupremacyWPF are older UI infrastructure stuff, much of which has been phased out and replaced by newer and better stuff in SupremacyClientComponents. The most interesting stuff in SupremacyUI is GalaxyGridPanel, which draws the galactic map. It also has the spinning planet views.
*** Supremacy.Xna is where the XNA/3D stuff is located--it's not used heavily yet, but it has some effects for the invasion screen, a newer star renderer, a 3D spinning ship renderer, etc.
*** Supremacy.Scripting is an expression language parser/compiler.
*** SupremacyClient is the main graphical client and has most of the game screen implementations.

*old source code can be taken from here: http://supremacy.codeplex.com/ (last upload from MStrobel at 03.01.2011)

==== ClientContext vs AppContext ====

taken from https://bitbucket.org/kflanagan/supremacydev/commits/0d562ce676425cd5da19cfdbcf1b6c18c7d0d135

*IClientContext is used by SupremacyCore to interface clients participating on a game, both local and over network. The IClientContext further includes an interface to IGameContext which gives access to the game data itself inside the '''SupremacyClient app'''
*However there should be an option to also include local properties not known to the Core, which is why this is done alternatively another context would have to be introduced for local data, but then still all the client code would have to be updated to make use of it

==== .XAML files ====

In Windows Presentation Foundation (WPF), a windows app framework used by Supremacy, XAML forms a user interface markup language to define UI elements, data binding, events, and other features.

Info resources:

*MS Article: [https://msdn.microsoft.com/en-us/library/ms745683(v=vs.110).aspx XAML Styling and Templating]

*Youtube video: [https://www.youtube.com/watch?v=0qE5hyuU9hE Introduction to XAML] (26min)

== Bitbucket ==

*https://confluence.atlassian.com/display/BITBUCKET/Maintaining+a+Mercurial+Repository

== Changes ==

see [[ChangeLog|here]] or https://bitbucket.org/mstrobel/supremacy/commits/branch/default

=== 2016 ===

==== XAML ====

*January 2016 [Planned]: Hope to get Major Race specific UI build through use of generic XAML files.
* ClientApp.xaml.cs has the code to direct UI to race specific folders of xaml files in SupremacyClient/themes/{0}

Looking at SystemScreen.xaml, Global.xaml and ClientModules.cs in Themes/SupremacyClient
See also generic.xaml in SupremacyClientComponents/Themes/InfoCard Theme.xaml Default.xaml Icons.xaml ClientApp.xaml.cs SystemScreen.xaml

1/17/16: Found that Mikes code in ClientApp.xaml.cs will already select for Major race. Need new folders for each major race in SupremacyClient/themes/(major race), edit paths to Resources in the .xaml files found in each races set of .xaml files. File names in SupremacyClient/themes/(major race) are not unique but content in Resources is. Now you can edit files in Resources for unique UI.

2/13/16:

<Polygon
Points="300,200 400,125 400,275 300,200"
Stroke="Purple"
StrokeThickness="2">
<Polygon.Fill>
<SolidColorBrush Color="Blue" Opacity="0.4"/>
</Polygon.Fill>
</Polygon>

Makes a left pointing triangle, purple outline and blue body

=== 2015 ===

*'''Animation.cs''' (animation of opening screen): This is where we can set the number of images, frames, and the rate they play at, currently all images in 30 seconds. We may want that to run faster. The images you will make for the ship de-cloaking will be located in Resources / Images / Animation.
* \supremacyclient\'''ClientModule.cs''':
**Found a place to add the right mouse click instructions for the Panel Access Menu. A thing called the statusWindow held the text "loading" while you wait for a game to load. Added the information there for new players

*FMOD is partly replace by AudioEngine.cs and others - just find it out

=== 2014 ===

== some code ==

for Theme and UI see >> '''[[Theme]]'''

=== miscellaneous ===

*Mainline\SupremacyClient\GameContextMenu.cs

*\Mainline\SupremacyUI\SystemProductionPanel.cs

*\Mainline\SupremacyCore\Orbitals\FleetOrders.cs -> all items inside a sector

*Mainline\SupremacyClient\GameContextMenu.cs (Access Popup Menu - or use F1 to F5)

*\Mainline\SupremacyClientComponents\Controls\InfoCard\InfoCard.cs (-> Tooltips ??)
**\Mainline\SupremacyClient\themes\Federation\InfoCard.xaml -> <Setter Property="Width" Value="500" /> (BEFORE: 250)

*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyPlanetaryBuildQueueView.xaml - Colonies Screen Content

*\Mainline\SupremacyCore\Universe\Colony.cs
*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyStructureListView.xaml
**Size of this area: 720 x 240

*\Mainline\SupremacyClient\Views\GalaxyScreen\TaskForceListView.xaml

=== Version Number ===

Look for version number control in AssemblyInfo.cs

your hard disk code folder BotF2\SupremacyClient\Properties\AssemblyInfo.cs

---
example code: (put in your current star date)

*[assembly: AssemblyVersion("2018.11.20.0")]
*[assembly: AssemblyFileVersion("2018.11.20.0")]

=== Ships ===

*\Fleets.cs
*\FleetOrder.cs (without a "s" - beware of it)
*\FleetOrders.cs

*\mainline\supremacyclientcomponents\views\galaxyscreen\galaxyscreenpresenter.cs TaskForcesList

==== Building Ships ====

*Cancelling -> Breakpoint at Line 185 at OnShipyardBuildProjectsChanged() \Mainline\SupremacyClientComponents\Views\ColonyScreen\ColonyScreenPresentationModel.cs

=== Sounds ===

*\Mainline\SupremacyClient\AudioEngine.cs (for Music), for Sounds >> SoundPlayerAction is used (search for \Resources\UI\Federation\SoundsButtonClick.wav)
*and in \Mainline\SupremacyClientComponents\Views\SystemAssaultScreen\SystemAssaultScreenViewModel.cs -> Uri is used (e.g. CombatLaser.wav)

=== Galaxy Generator ===

*\Mainline\SupremacyCore\Universe\GalaxyGenerator.cs

=== Values ===
*CivID: 0 = Federation...

=== TurnPhase ===

WaitOnPlayers = 0,
PreTurnOperations,
ResetObjects,
FleetMovement,
Combat,
PopulationGrowth,
PersonnelTraining,
Research,
Scrapping,
Maintenance,
ShipProduction,
Production,
Trade,
Morale,
MapUpdates,
PostTurnOperations,
SendUpdates,
Diplomacy,
WaitOnAIPlayers

=== older list ===

{|class="wikitable sortable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |where
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Folder
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |File
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Function
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Date
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Description
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameContext.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
initialising game
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|
Raw Materials, Deuterium, Dilithium is collected cross over all colonies and used by all colonies
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoShipProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|

|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Combat
|style=text-align:center|InvasionArena.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
SystemAssault
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Orbital
|style=text-align:center|Shipyard.cs
|style=text-align:center|GetBuildOutput(int slot)
|style=text-align:center| [https://bitbucket.org/Bloodwurm/BotF2dev/commits/1aafc8f6e47e9e3b9c20de79f2d02f197c023d63 2014-01-15]
|style=text-align:left|
just selects output (active?) and bonus (BonusType.PercentShipBuilding), since 2014-01-15 also case PopulationRatio or IndustryRatio
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|GetProductionOutput(ProductionCategory category)
|style=text-align:center|
|style=text-align:left|
see last line, too !
*Food: minimum 10
*Research:
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*Industry: '''minimum 10 !'''
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*last line: return ((int)(baseOutput + (baseOutput * modifier.Efficiency)) + modifier.Bonus);
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasFoodBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasFoodBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasEnergyBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasEnergyBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-ClientComp
|style=text-align:center|Views\GalaxyScreen
|style=text-align:center|GalaxyScreenView.cs
|style=text-align:center|GalaxyScreenView()
|style=text-align:center|
|style=text-align:left|GalaxyView Hotkeys Definition (see [[Hotkey]]s)
|style=text-align:left|
|style=text-align:left|

|}

== Botf2-coding-practice ==

*http://star-trek-supremacy.proboards.com/thread/349/botf2-coding-practice (intern)

*prepare:
**...we are using SourceTree, provided by bitbucket (another option: TortoiseHg with Mercurial - to access the supremacy code repository http://tortoisehg.bitbucket.org/)
**PuTTYgen - to generate a ssh key to allow using ssh protocol instead of slow https http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
***or use C:\Program Files (x86)\Atlassian\SourceTree\tools\putty..puttygen.exe....generate a key (using a phrase is not neccessary)
***copy the public key (4-5 lines) into your bitbucket account/profile under SSH Keys, label it with any title and CopyPaste
**we are using Visual Studio Community 2013 Update 4 (select the Community Version) https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
**we are not(!) using Visual Studio Community 2015 RC - to compile the code (ISO is recommend)....still need to check if Supremacy code compiles with it, so instead we might need to depend on VS2013 http://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs....for VS 2015 we read to create a new project, import Supremacy and go through all the issues
**you also need to have an account on http://bitbucket.org
**and you should have Skype installed to participate in the meetings we have

*when you attempt to clone by ssh instead of https, check the following tutorial: http://confluence.atlassian.com/display/BITBUCKET/Set+up+SSH+for+Mercurial

*here some simple text editors useful to edit stuff like xml files, just pick the one you prefer they all are great:
**http://www.sublimetext.com/
**http://www.contexteditor.org/index.php
**http://notepad-plus-plus.org/ (used by reg atm)

== SourceTree ==

*Download >> https://www.sourcetreeapp.com/?v=win (or while cloning...use the link below blue Clone Button)

*Tools: 3rd point: OPTIONS

*SSH Client Configuration:
**SSH Key: c:\....\ReginaldPutty.ppk
**SSH Client: (IMPORTANT) PuTTY/Link (not SSH !!)
**automatically start: yes

== Visual Studio ==

It's possible (and standard) to compile the game with Visual Studio. No further stuff of programs is needed, except matching Resources folder. Mention that the compiled exe is then in \Mainline\bin\Debug (or \Release).

=== VS2019 ===

* meanwhile we are on VS 2019 Community version https://www.visualstudio.com/downloads

* see hints for VS 2017 especially >> Set as Start Project > SupremacyClient (View SolutionExplorer > SupremacyClient > right mouse click ...in the middle)

=== VS2017 ===

In May 2017 we're trying to change to VS 2017 Community version https://www.visualstudio.com/downloads

*you might want to change language at TOOLS > OPTIONS > ENVIROMENT > INTERNATIONAL SETTINGS

* first make a clean !!, maybe for each single project (10 of 10)

* SOLUTION EXPLORER - right mouse click - retarget (in the middle) - select newest versions

* (this should be only needed once and should be uploaded to Repository by one guy) SupremacyClient > Set as start Project

*after cleaning maybe use REBUILD

for more see >> [[#Tools|here]]

=== VS2015 ===

since April 2016 we're using VS 2015

*Visual Studio '''Community''' 2015 RC - to compile the code (ISO is recommend) ... still need to check if Supremacy code compiles with it, so instead we might need VS2013. NEW: we try to go to VS 2015 now.
https://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs - you need the "Community" Version, currently (Apr 2016) version "Update 2"

==== VS 2015 Update 3 ====

*says it does uninstall Update 2
*needs update to 33 GB to install (only if every is selected) - seems to need some hours...

=== old VS ===

this is out of date due to code has changed

==== Visual C++ Library ====

IMPORTANT: As Microsoft no longer provides Visual C++ Library as standard installed component ...don't forget to select or install this manually! In VS you can recognize it if \Supremacy Native is unload (sign is greyed out a little bit)

===== SupremacyNative =====

SupremacyNative is C++ coded. Sometimes there are some problems with it https://developercommunity.visualstudio.com/content/problem/312852/internal-compiler-error-in-vs158-msc1cpp-line-1518.html

*Visual Studio Community 2013 (Community version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2012 (Express version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2008 (German) http://www.microsoft.com/de-de/download/details.aspx?id=13276

=== Tools ===

*Indent Guides https://visualstudiogallery.msdn.microsoft.com/e792686d-542b-474a-8c55-630980e72c30 Adds vertical lines at each indent level.

* Vertical tabs https://marketplace.visualstudio.com/items?itemName=VisualStudioProductTeam.ProductivityPowerPack2017

*PowerShell Tools für VS 2015

=== Tips ===
*TOOLS > OPTIONS > ENVIRONMENT > Color theme -> Black

*TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Detect when file is changed outside... -> Yes
**TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Reload modified files... -> Yes

*DEBUG > OPTIONS > PROJECTS... > BUILD AND RUN > when code=project is changed="out of date" > "Always Build" (checkbox "only build ...on Run" is marked)
**https://www.vb-paradise.de/index.php/Thread/47935-Code-bei-Klick-auf-Debugging-starten-kompilieren-wenn-er-sich-ge%C3%A4ndert-hat/

*TOOLS > OPTIONS > TEXT EDITOR > ALL LANGUAGES > Line Number (activate for all)

*DEBUG > SUPREMACY CLIENT PROPERTIES (last) > DEBUG > Start project > Command line arguments: "-aiexplore -SAVEDGAME:auto" (if you save in Supremacy manually a game with name "auto" (independent from game's "(autosave)", this manually saved game can be loaded at startup.
**"-aiexplore" isn't necessary. For more see [[Command line parameter]]
**if working for example on Cardassian UI just save Cardassian as "auto".
**when you want to change to Klingons, just retire and start Klingons. If you want to work steady on Klingons, save a Klingon's game with auto.
**if you want to start a new game steady, just go Command line arguments (see above) and change the filename to an unused one like "-SAVEDGAME:auto123"

*activate Toolbar BUILD by right mouse click on Toolbar line

* Tools -> Options -> Debugging -> Output Window -> Module Load Messages -> Off

==== Editor ====
we're using some different editors
*one option is to drag'n'drop files like xml to Visual Studio
*sometimes we use Notepad++ https://notepad-plus-plus.org/download with Extension Compare (PLUGINS > PLUGIN MANAGER > SHOW P-Manager > "Compare" ...install
*for a black style we use Sublime http://www.sublimetext.com/2

==== Screenshot ====

*reg likes Greenshot http://getgreenshot.org/
**puts an icon into task bar. There: > PREFERENCES
***PREFERENCES > GENERAL: reg uses for "Capture region" CRTL+PRNT (and no other hotkey)
***PREFERENCES > OUTPUT: define a folder at "Storage location" and a standard file type (default is *.png)
***PREFERENCES > DESTINATION: (reg's settings)
****- turn off "Select destination dymnamically"
****- open in image editor
****- copy to clipboard
**Usage:
***press Hotkey and make Screenshot
***paste immediately anywhere OR
***work on it inside Greenshot (give red circles or mark up in any colour), give numbers, obfuscate and more
***save or save as jpg or print

== Compiling ==

if you have an error with "Glyphs.xaml", than make sure you have copied \Resources MANUALLY into the output folders - this was changed in 2015. The output folder depends on compiling method "Debug" or "Release", it is
*for DEBUG _: (YourRepositoryFolder)\Mainline\bin\'''Debug\Resources''' or
*for RELEASE: (YourRepositoryFolder)\Mainline\bin\'''Release\Resources'''

it's creating:
*1> Supremacy.Scripting -> %path_repo%\bin\Debug\lib\Supremacy.Scripting.dll
*2> SupremacyCore -> %path_repo%\bin\Debug\lib\SupremacyCore.dll
*3> Supremacy.Xna -> %path_repo%\bin\Debug\lib\Supremacy.Xna.dll
*4> SupremacyClientComponents -> %path_repo%\bin\Debug\lib\SupremacyClientComponents.dll
*5> SupremacyWPF -> %path_repo%\bin\Debug\lib\SupremacyWPF.dll
*6> SupremacyService -> %path_repo%\bin\Debug\lib\SupremacyService.dll
*7> SupremacyUI -> %path_repo%\bin\Debug\lib\SupremacyUI.dll

== Visual C# ==

build in Visual Studio

<img>http://botf2.square7.ch/wiki-files/images/VS2015.jpg</img>

== SunBurn ==

SunBurn is on hold for now. Kenneth was working sometimes with SunBurn...this might be a site for this http://channel9.msdn.com/coding4fun/blog/No-need-for-sunscreen-you-want-this-SunBurn-SunBurn-v2-RTMs-including-the-free-SunBurn-Framework-Edi

*http://en.wikipedia.org/wiki/List_of_game_engines

== .Net ==

you should use latest [http://www.microsoft.com/net .Net-version] (2014: version 4.5.1)

== XNA ==

"Could not load file or assembly 'Microsoft.Xna.Framework.dll' or one of its dependencies. The specified module could not be found."

*suggestion by reg: go to \Resources\Models and rename the "Models"-folder to "Models-SetOffline" or something else (if building a ship no model is shown -as it is to most of the ships- but otherwise the game could work fine)

This suggests the problem is with your XNA installation. The game uses XNA to display the 3D ship models in the shipyard. There's no way to disable the models so XNA wouldn't be needed. So to be able to play the game, i'd advise to uninstall XNA, then install the latest version.

XNA 3.1 (this one you need in any case): http://www.microsoft.com/en-us/download/details.aspx?id=15163

XNA 4.0 Download link: http://www.microsoft.com/en-gb/download/details.aspx?id=20914

== Try ==

(for boolean)

try
{
return true;
}
catch (Exception e)
{
var errors = new System.Collections.Concurrent.ConcurrentStack<Exception>();
errors.Push(e);
return false;
}
finally
{
xxx;
}
;

== Contexts ==

*AppContext (programm running)
*GameContext.Current (Game started - so after StartScreen)
*PlayerContext.Current

== Text ==
=== en.txt ===
* XAML example: Text="{s:StringResource EMPIRES_HEADER}"
* string _text = String.Format(ResourceManager.GetString("KEY_IN-EN_TXT"),parameter1, parameter2;

== LocalPlayer ==

*AppContext.LocalPlayer (just inside XAML-code files ??)

== Civilization ==

just the data out of Civilization.xml ... for more see [[#CivilizationManager]]

== CivilizationManager ==

CivilizationManager holds all the data like amount of credits, diplomacy, sitreps and more

*GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

== GameLog ==

if not available, try "Quick actions" -> using Supremacy.Utility;

GameLog.Core.GameData.DebugFormat("Turn {0};xx=;{1};xx=;{2};xx={3};xx={4};xx={5};xx={6};xx={7};xx={8};xx={9};"
, GameContext.Current.TurnNumber
, xx
, xx
);

== Dictionary ==

private static Dictionary<string, bool> _acceptRejectDictionary = new Dictionary<string, bool> { { "98", false } };

== MessageBox (Windows Style) ==

MessageBox.Show("Borg turned into Expanded", "WARNING", MessageBoxButton.OK);

== MessageDialog (Supremacy Style) ==

var result = MessageDialog.Show("Borg turned into Expanded", MessageDialogButtons.YesNo);

== SoundPlaying ==

* _soundPlayer.PlayFile("Resources/SoundFX/ChatMessage.wav");

Source Code

2020-12-05T10:02:39Z

Reginald: /* Visual Studio */

== Source Code ==

http://guganeshan.com/blog/setting-up-git-and-tortoisegit-with-bitbucket-step-by-step.html

=== official ===

* code is now at https://github.com/BotF2/BotF2.git

*last source code https://bitbucket.org/mstrobel/supremacy/overview (it's in C#, also named CSharp. [[#Visual Studio]] is used for coding.)
**Mike's Post: build in [http://www.microsoft.com/downloads/dlx/en-us/ThankYou.aspx?FamilyID=75568AA6-8107-475D-948A-EF22627E57A5 VS2010] with .NET 4.0. You may need the [http://en.csharp-online.net/Download_Free_Microsoft_Visual_CSharp_.NET#Download_Microsoft_Visual_Studio_Async_Community_Technology_Preview_.28CTP.29 C# Async CTP]. http://bote2.square7.ch/forum/viewtopic.php?p=70790#p70790
**http://bote2.square7.ch/forum/viewtopic.php?p=70781#p70781
*** Supremacy.Game.GameEngine is where you'll find most of the game logic. That's where most of the turn processing happens.
*** The SupremacyCore project is where you'll find the foundation of the game.
*** SupremacyService is just the game server (all the important bits it interacts with are in SupremacyCore).
*** SupremacyClientComponents is UI infrastructure.
*** SupremacyUI and SupremacyWPF are older UI infrastructure stuff, much of which has been phased out and replaced by newer and better stuff in SupremacyClientComponents. The most interesting stuff in SupremacyUI is GalaxyGridPanel, which draws the galactic map. It also has the spinning planet views.
*** Supremacy.Xna is where the XNA/3D stuff is located--it's not used heavily yet, but it has some effects for the invasion screen, a newer star renderer, a 3D spinning ship renderer, etc.
*** Supremacy.Scripting is an expression language parser/compiler.
*** SupremacyClient is the main graphical client and has most of the game screen implementations.

*old source code can be taken from here: http://supremacy.codeplex.com/ (last upload from MStrobel at 03.01.2011)

==== ClientContext vs AppContext ====

taken from https://bitbucket.org/kflanagan/supremacydev/commits/0d562ce676425cd5da19cfdbcf1b6c18c7d0d135

*IClientContext is used by SupremacyCore to interface clients participating on a game, both local and over network. The IClientContext further includes an interface to IGameContext which gives access to the game data itself inside the '''SupremacyClient app'''
*However there should be an option to also include local properties not known to the Core, which is why this is done alternatively another context would have to be introduced for local data, but then still all the client code would have to be updated to make use of it

==== .XAML files ====

In Windows Presentation Foundation (WPF), a windows app framework used by Supremacy, XAML forms a user interface markup language to define UI elements, data binding, events, and other features.

Info resources:

*MS Article: [https://msdn.microsoft.com/en-us/library/ms745683(v=vs.110).aspx XAML Styling and Templating]

*Youtube video: [https://www.youtube.com/watch?v=0qE5hyuU9hE Introduction to XAML] (26min)

== Bitbucket ==

*https://confluence.atlassian.com/display/BITBUCKET/Maintaining+a+Mercurial+Repository

== Changes ==

see [[ChangeLog|here]] or https://bitbucket.org/mstrobel/supremacy/commits/branch/default

=== 2016 ===

==== XAML ====

*January 2016 [Planned]: Hope to get Major Race specific UI build through use of generic XAML files.
* ClientApp.xaml.cs has the code to direct UI to race specific folders of xaml files in SupremacyClient/themes/{0}

Looking at SystemScreen.xaml, Global.xaml and ClientModules.cs in Themes/SupremacyClient
See also generic.xaml in SupremacyClientComponents/Themes/InfoCard Theme.xaml Default.xaml Icons.xaml ClientApp.xaml.cs SystemScreen.xaml

1/17/16: Found that Mikes code in ClientApp.xaml.cs will already select for Major race. Need new folders for each major race in SupremacyClient/themes/(major race), edit paths to Resources in the .xaml files found in each races set of .xaml files. File names in SupremacyClient/themes/(major race) are not unique but content in Resources is. Now you can edit files in Resources for unique UI.

2/13/16:

<Polygon
Points="300,200 400,125 400,275 300,200"
Stroke="Purple"
StrokeThickness="2">
<Polygon.Fill>
<SolidColorBrush Color="Blue" Opacity="0.4"/>
</Polygon.Fill>
</Polygon>

Makes a left pointing triangle, purple outline and blue body

=== 2015 ===

*'''Animation.cs''' (animation of opening screen): This is where we can set the number of images, frames, and the rate they play at, currently all images in 30 seconds. We may want that to run faster. The images you will make for the ship de-cloaking will be located in Resources / Images / Animation.
* \supremacyclient\'''ClientModule.cs''':
**Found a place to add the right mouse click instructions for the Panel Access Menu. A thing called the statusWindow held the text "loading" while you wait for a game to load. Added the information there for new players

*FMOD is partly replace by AudioEngine.cs and others - just find it out

=== 2014 ===

== some code ==

for Theme and UI see >> '''[[Theme]]'''

=== miscellaneous ===

*Mainline\SupremacyClient\GameContextMenu.cs

*\Mainline\SupremacyUI\SystemProductionPanel.cs

*\Mainline\SupremacyCore\Orbitals\FleetOrders.cs -> all items inside a sector

*Mainline\SupremacyClient\GameContextMenu.cs (Access Popup Menu - or use F1 to F5)

*\Mainline\SupremacyClientComponents\Controls\InfoCard\InfoCard.cs (-> Tooltips ??)
**\Mainline\SupremacyClient\themes\Federation\InfoCard.xaml -> <Setter Property="Width" Value="500" /> (BEFORE: 250)

*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyPlanetaryBuildQueueView.xaml - Colonies Screen Content

*\Mainline\SupremacyCore\Universe\Colony.cs
*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyStructureListView.xaml
**Size of this area: 720 x 240

*\Mainline\SupremacyClient\Views\GalaxyScreen\TaskForceListView.xaml

=== Version Number ===

Look for version number control in AssemblyInfo.cs

your hard disk code folder BotF2\SupremacyClient\Properties\AssemblyInfo.cs

---
example code: (put in your current star date)

*[assembly: AssemblyVersion("2018.11.20.0")]
*[assembly: AssemblyFileVersion("2018.11.20.0")]

=== Ships ===

*\Fleets.cs
*\FleetOrder.cs (without a "s" - beware of it)
*\FleetOrders.cs

*\mainline\supremacyclientcomponents\views\galaxyscreen\galaxyscreenpresenter.cs TaskForcesList

==== Building Ships ====

*Cancelling -> Breakpoint at Line 185 at OnShipyardBuildProjectsChanged() \Mainline\SupremacyClientComponents\Views\ColonyScreen\ColonyScreenPresentationModel.cs

=== Sounds ===

*\Mainline\SupremacyClient\AudioEngine.cs (for Music), for Sounds >> SoundPlayerAction is used (search for \Resources\UI\Federation\SoundsButtonClick.wav)
*and in \Mainline\SupremacyClientComponents\Views\SystemAssaultScreen\SystemAssaultScreenViewModel.cs -> Uri is used (e.g. CombatLaser.wav)

=== Galaxy Generator ===

*\Mainline\SupremacyCore\Universe\GalaxyGenerator.cs

=== Values ===
*CivID: 0 = Federation...

=== TurnPhase ===

WaitOnPlayers = 0,
PreTurnOperations,
ResetObjects,
FleetMovement,
Combat,
PopulationGrowth,
PersonnelTraining,
Research,
Scrapping,
Maintenance,
ShipProduction,
Production,
Trade,
Morale,
MapUpdates,
PostTurnOperations,
SendUpdates,
Diplomacy,
WaitOnAIPlayers

=== older list ===

{|class="wikitable sortable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |where
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Folder
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |File
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Function
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Date
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Description
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameContext.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
initialising game
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|
Raw Materials, Deuterium, Dilithium is collected cross over all colonies and used by all colonies
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoShipProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|

|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Combat
|style=text-align:center|InvasionArena.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
SystemAssault
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Orbital
|style=text-align:center|Shipyard.cs
|style=text-align:center|GetBuildOutput(int slot)
|style=text-align:center| [https://bitbucket.org/Bloodwurm/BotF2dev/commits/1aafc8f6e47e9e3b9c20de79f2d02f197c023d63 2014-01-15]
|style=text-align:left|
just selects output (active?) and bonus (BonusType.PercentShipBuilding), since 2014-01-15 also case PopulationRatio or IndustryRatio
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|GetProductionOutput(ProductionCategory category)
|style=text-align:center|
|style=text-align:left|
see last line, too !
*Food: minimum 10
*Research:
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*Industry: '''minimum 10 !'''
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*last line: return ((int)(baseOutput + (baseOutput * modifier.Efficiency)) + modifier.Bonus);
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasFoodBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasFoodBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasEnergyBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasEnergyBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-ClientComp
|style=text-align:center|Views\GalaxyScreen
|style=text-align:center|GalaxyScreenView.cs
|style=text-align:center|GalaxyScreenView()
|style=text-align:center|
|style=text-align:left|GalaxyView Hotkeys Definition (see [[Hotkey]]s)
|style=text-align:left|
|style=text-align:left|

|}

== Botf2-coding-practice ==

*http://star-trek-supremacy.proboards.com/thread/349/botf2-coding-practice (intern)

*prepare:
**...we are using SourceTree, provided by bitbucket (another option: TortoiseHg with Mercurial - to access the supremacy code repository http://tortoisehg.bitbucket.org/)
**PuTTYgen - to generate a ssh key to allow using ssh protocol instead of slow https http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
***or use C:\Program Files (x86)\Atlassian\SourceTree\tools\putty..puttygen.exe....generate a key (using a phrase is not neccessary)
***copy the public key (4-5 lines) into your bitbucket account/profile under SSH Keys, label it with any title and CopyPaste
**we are using Visual Studio Community 2013 Update 4 (select the Community Version) https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
**we are not(!) using Visual Studio Community 2015 RC - to compile the code (ISO is recommend)....still need to check if Supremacy code compiles with it, so instead we might need to depend on VS2013 http://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs....for VS 2015 we read to create a new project, import Supremacy and go through all the issues
**you also need to have an account on http://bitbucket.org
**and you should have Skype installed to participate in the meetings we have

*when you attempt to clone by ssh instead of https, check the following tutorial: http://confluence.atlassian.com/display/BITBUCKET/Set+up+SSH+for+Mercurial

*here some simple text editors useful to edit stuff like xml files, just pick the one you prefer they all are great:
**http://www.sublimetext.com/
**http://www.contexteditor.org/index.php
**http://notepad-plus-plus.org/ (used by reg atm)

== SourceTree ==

*Download >> https://www.sourcetreeapp.com/?v=win (or while cloning...use the link below blue Clone Button)

*Tools: 3rd point: OPTIONS

*SSH Client Configuration:
**SSH Key: c:\....\ReginaldPutty.ppk
**SSH Client: (IMPORTANT) PuTTY/Link (not SSH !!)
**automatically start: yes

== Visual Studio ==

It's possible (and standard) to compile the game with Visual Studio. No further stuff of programs is needed, except matching Resources folder. Mention that the compiled exe is then in \Mainline\bin\Debug (or \Release).

=== VS2019 ===

* meanwhile we are on VS 2019 Community version https://www.visualstudio.com/downloads

=== VS2017 ===

In May 2017 we're trying to change to VS 2017 Community version https://www.visualstudio.com/downloads

*you might want to change language at TOOLS > OPTIONS > ENVIROMENT > INTERNATIONAL SETTINGS

* first make a clean !!, maybe for each single project (10 of 10)

* SOLUTION EXPLORER - right mouse click - retarget (in the middle) - select newest versions

* (this should be only needed once and should be uploaded to Repository by one guy) SupremacyClient > Set as start Project

*after cleaning maybe use REBUILD

for more see >> [[#Tools|here]]

=== VS2015 ===

since April 2016 we're using VS 2015

*Visual Studio '''Community''' 2015 RC - to compile the code (ISO is recommend) ... still need to check if Supremacy code compiles with it, so instead we might need VS2013. NEW: we try to go to VS 2015 now.
https://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs - you need the "Community" Version, currently (Apr 2016) version "Update 2"

==== VS 2015 Update 3 ====

*says it does uninstall Update 2
*needs update to 33 GB to install (only if every is selected) - seems to need some hours...

=== old VS ===

this is out of date due to code has changed

==== Visual C++ Library ====

IMPORTANT: As Microsoft no longer provides Visual C++ Library as standard installed component ...don't forget to select or install this manually! In VS you can recognize it if \Supremacy Native is unload (sign is greyed out a little bit)

===== SupremacyNative =====

SupremacyNative is C++ coded. Sometimes there are some problems with it https://developercommunity.visualstudio.com/content/problem/312852/internal-compiler-error-in-vs158-msc1cpp-line-1518.html

*Visual Studio Community 2013 (Community version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2012 (Express version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2008 (German) http://www.microsoft.com/de-de/download/details.aspx?id=13276

=== Tools ===

*Indent Guides https://visualstudiogallery.msdn.microsoft.com/e792686d-542b-474a-8c55-630980e72c30 Adds vertical lines at each indent level.

* Vertical tabs https://marketplace.visualstudio.com/items?itemName=VisualStudioProductTeam.ProductivityPowerPack2017

*PowerShell Tools für VS 2015

=== Tips ===
*TOOLS > OPTIONS > ENVIRONMENT > Color theme -> Black

*TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Detect when file is changed outside... -> Yes
**TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Reload modified files... -> Yes

*DEBUG > OPTIONS > PROJECTS... > BUILD AND RUN > when code=project is changed="out of date" > "Always Build" (checkbox "only build ...on Run" is marked)
**https://www.vb-paradise.de/index.php/Thread/47935-Code-bei-Klick-auf-Debugging-starten-kompilieren-wenn-er-sich-ge%C3%A4ndert-hat/

*TOOLS > OPTIONS > TEXT EDITOR > ALL LANGUAGES > Line Number (activate for all)

*DEBUG > SUPREMACY CLIENT PROPERTIES (last) > DEBUG > Start project > Command line arguments: "-aiexplore -SAVEDGAME:auto" (if you save in Supremacy manually a game with name "auto" (independent from game's "(autosave)", this manually saved game can be loaded at startup.
**"-aiexplore" isn't necessary. For more see [[Command line parameter]]
**if working for example on Cardassian UI just save Cardassian as "auto".
**when you want to change to Klingons, just retire and start Klingons. If you want to work steady on Klingons, save a Klingon's game with auto.
**if you want to start a new game steady, just go Command line arguments (see above) and change the filename to an unused one like "-SAVEDGAME:auto123"

*activate Toolbar BUILD by right mouse click on Toolbar line

* Tools -> Options -> Debugging -> Output Window -> Module Load Messages -> Off

==== Editor ====
we're using some different editors
*one option is to drag'n'drop files like xml to Visual Studio
*sometimes we use Notepad++ https://notepad-plus-plus.org/download with Extension Compare (PLUGINS > PLUGIN MANAGER > SHOW P-Manager > "Compare" ...install
*for a black style we use Sublime http://www.sublimetext.com/2

==== Screenshot ====

*reg likes Greenshot http://getgreenshot.org/
**puts an icon into task bar. There: > PREFERENCES
***PREFERENCES > GENERAL: reg uses for "Capture region" CRTL+PRNT (and no other hotkey)
***PREFERENCES > OUTPUT: define a folder at "Storage location" and a standard file type (default is *.png)
***PREFERENCES > DESTINATION: (reg's settings)
****- turn off "Select destination dymnamically"
****- open in image editor
****- copy to clipboard
**Usage:
***press Hotkey and make Screenshot
***paste immediately anywhere OR
***work on it inside Greenshot (give red circles or mark up in any colour), give numbers, obfuscate and more
***save or save as jpg or print

== Compiling ==

if you have an error with "Glyphs.xaml", than make sure you have copied \Resources MANUALLY into the output folders - this was changed in 2015. The output folder depends on compiling method "Debug" or "Release", it is
*for DEBUG _: (YourRepositoryFolder)\Mainline\bin\'''Debug\Resources''' or
*for RELEASE: (YourRepositoryFolder)\Mainline\bin\'''Release\Resources'''

it's creating:
*1> Supremacy.Scripting -> %path_repo%\bin\Debug\lib\Supremacy.Scripting.dll
*2> SupremacyCore -> %path_repo%\bin\Debug\lib\SupremacyCore.dll
*3> Supremacy.Xna -> %path_repo%\bin\Debug\lib\Supremacy.Xna.dll
*4> SupremacyClientComponents -> %path_repo%\bin\Debug\lib\SupremacyClientComponents.dll
*5> SupremacyWPF -> %path_repo%\bin\Debug\lib\SupremacyWPF.dll
*6> SupremacyService -> %path_repo%\bin\Debug\lib\SupremacyService.dll
*7> SupremacyUI -> %path_repo%\bin\Debug\lib\SupremacyUI.dll

== Visual C# ==

build in Visual Studio

<img>http://botf2.square7.ch/wiki-files/images/VS2015.jpg</img>

== SunBurn ==

SunBurn is on hold for now. Kenneth was working sometimes with SunBurn...this might be a site for this http://channel9.msdn.com/coding4fun/blog/No-need-for-sunscreen-you-want-this-SunBurn-SunBurn-v2-RTMs-including-the-free-SunBurn-Framework-Edi

*http://en.wikipedia.org/wiki/List_of_game_engines

== .Net ==

you should use latest [http://www.microsoft.com/net .Net-version] (2014: version 4.5.1)

== XNA ==

"Could not load file or assembly 'Microsoft.Xna.Framework.dll' or one of its dependencies. The specified module could not be found."

*suggestion by reg: go to \Resources\Models and rename the "Models"-folder to "Models-SetOffline" or something else (if building a ship no model is shown -as it is to most of the ships- but otherwise the game could work fine)

This suggests the problem is with your XNA installation. The game uses XNA to display the 3D ship models in the shipyard. There's no way to disable the models so XNA wouldn't be needed. So to be able to play the game, i'd advise to uninstall XNA, then install the latest version.

XNA 3.1 (this one you need in any case): http://www.microsoft.com/en-us/download/details.aspx?id=15163

XNA 4.0 Download link: http://www.microsoft.com/en-gb/download/details.aspx?id=20914

== Try ==

(for boolean)

try
{
return true;
}
catch (Exception e)
{
var errors = new System.Collections.Concurrent.ConcurrentStack<Exception>();
errors.Push(e);
return false;
}
finally
{
xxx;
}
;

== Contexts ==

*AppContext (programm running)
*GameContext.Current (Game started - so after StartScreen)
*PlayerContext.Current

== Text ==
=== en.txt ===
* XAML example: Text="{s:StringResource EMPIRES_HEADER}"
* string _text = String.Format(ResourceManager.GetString("KEY_IN-EN_TXT"),parameter1, parameter2;

== LocalPlayer ==

*AppContext.LocalPlayer (just inside XAML-code files ??)

== Civilization ==

just the data out of Civilization.xml ... for more see [[#CivilizationManager]]

== CivilizationManager ==

CivilizationManager holds all the data like amount of credits, diplomacy, sitreps and more

*GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

== GameLog ==

if not available, try "Quick actions" -> using Supremacy.Utility;

GameLog.Core.GameData.DebugFormat("Turn {0};xx=;{1};xx=;{2};xx={3};xx={4};xx={5};xx={6};xx={7};xx={8};xx={9};"
, GameContext.Current.TurnNumber
, xx
, xx
);

== Dictionary ==

private static Dictionary<string, bool> _acceptRejectDictionary = new Dictionary<string, bool> { { "98", false } };

== MessageBox (Windows Style) ==

MessageBox.Show("Borg turned into Expanded", "WARNING", MessageBoxButton.OK);

== MessageDialog (Supremacy Style) ==

var result = MessageDialog.Show("Borg turned into Expanded", MessageDialogButtons.YesNo);

== SoundPlaying ==

* _soundPlayer.PlayFile("Resources/SoundFX/ChatMessage.wav");

UI

2020-11-22T15:48:33Z

Reginald: /* Button */

== Intro ==

some words to UI....

* starting a game starts every of the five screens at the same time ! (Map/System/...)

* inside the screens it is mostly jumping to the last selected tab (e.g. System: Production or Shipbuilding)
** these complete screens are done by different parts:
***left top: Template like SystemInfo
***left bottom: Template like BuildQueue
***right: ProductionScreen
***right bottom: Planets...

== Theme ==

* Themes are appearance of each Empire's UI.

Common stuff is content of Global.xaml

Empire's themes are defined in Shared.xaml

=== Border ===

* LCARS_BorderStyle (e.g. Chat-Window)
* LCARS_ThinBorderStyle (e.g. Summary)

=== Button ===

* GameButton // e.g. Economy
** Style
** Normal = just Text rectangle
** Tiny
**
* LCARS_BorderButtonStyle
* LCARS_BorderToggleButtonStyle" // e.g. CHAT Button in GalaxyMapView
* LCARS_SimpleButtonStyle // e.g. REDEPLOY-Button
* LCARS_SimpleToggleButtonStyle

* Default = IsEnable = Current Selection = GREEN = LCARS_Dom3Gradient_Bottom_Top
* MouseOver = PINK GRADIENT = LCARS_Dom2Gradient_Bottom_Top
* IsPressed = PINK = LCARS_Dom1Gradient_Bottom_Top
* IsChecked

=== TextBrush ===

Usage: {StaticResource HeaderTextBrush}
*DefaultTextBrush"
*HeaderTextBrush"
*LCARS_HeaderBrush"
*DisabledTextBrush"
*SelectionBrush"
*BorderBrush"

----

* ControlTextForegroundBrushKey

* HeaderTextForegroundBrushKey

* DefaultTextForegroundBrushKey

* ImageBorderBrushKey

* DisabledTextForegroundBrushKey

* HighlightBrushKey

* InactiveHighlightBrushKey

* AlertTextForegroundBrushKey

* HighlightBrushKey

== Colour ==

=== LightBlue ===
* Research
* Dilithium

=== Red ===
* Deuterium

=== Silver ===
* Intelligence

=== Gray ===
* Duranium = Rax Materials

=== Goldrod ===
* Energy
* Total Population in EmpireInfo

=== Borg ===

*LCARS_GreenTextBrush

*DarkGreen

== ClientApp ==

* SupremacyClient\ClientApp.xaml.cs - this is the main app - starting at "EntryPoint"
* SupremacyClient\ClientWindow.xaml.cs - this is the main window

== MultiplayerSetupScreen ==

* MultiplayerSetupScreen.xaml + MultiplayerSetupScreen.xaml.cs

== SUMMARY ==

SitReps are a part of CivManager of a Civilization...

* SitRepEntry.cs (contains a Global SitRep-Function and special ones)

* SitRepDialog.xaml ( = Dialog )
* SitRepDialog.xaml.cs ( Logic for Dialog = Filter on/off )

== Context Menu ==

* SupremacyClient\themes\Dominion\GameContextMenu.xaml
* GalaxyScreenView.xaml

== Bottom View ==

various parts are filled in

=== PlanetsViewRegion ===

* \SupremacyUI\StarSystemPanel.cs

=== AssignedShipListRegion ===

* AssignedShipListRegion

=== PART_ChatPanel ===

* PART_ChatPanel

== F1 ==

* GalaxyScreenView.xaml (Race specific)

* Expander EmpireInfo > EmpireInfoView.xaml

== F2 ==

=== Right ===

* SystemProductionPanel.cs (without any xaml file !)

=== Left ===

* ColonyHandlingListView.cs

== F3 ==

* NewDiplomacyScreen.xaml + NewDiplomacyScreen.xaml.cs
* DiplomacyScreenViewModel.cs
* \SupremacyCore\Diplomacy\DiplomacyHelper.cs
* DiplomatAI.cs
* ForeignPowerViewModel.cs

* DiplomacyMessageViewModel.cs and more

* AcceptProposalVisitor.cs
* RejectProposalVisitor.cs

== F4 ==

== F5 ==

* AssetsScreen.xaml + AssetsScreen.xaml.cs
** TAB: Colonies -> a) Headline directly in AssetsScreen.xaml
** TAB: Colonies -> b) ColonyList ="{Binding Path=Colonies} -> SystemListItem.xaml (+.cs)
*
** TAB: SpyReport -> b)

* AssetsScreenPresentationModel.cs

* ActiveAgreementViewModel.cs

== F11 ==

* File:CheatMenu.xaml + File:CheatMenu.xaml.cs

== CTRL+F11 ==

* FakeDialog.xaml + FakeDialog.xaml.cs

== ClientSettings ==

* ClientSettings.cs - stuff is written into file > ClientSettings.xaml

=== CTRL+O ===

* ClientOptionsDialog.xaml + ClientOptionsDialog.xaml.cs

==== File:ClientOptionsDialog.xaml ====

* File:ClientOptionsDialog.xaml

=== CTRL+Z ===

* ClientTracesDialog.xaml + ClientTracesDialog.xaml.cs

==== File:TracesOptionsPage.xaml ====

* File:TracesOptionsPage.xaml + File:TracesOptionsPage.xaml.cs

== GameOptionsPanel ==

at Starting

* GameOptionsPanel.xaml + GameOptionsPanel.xaml.cs

== LoadGameDialog ==

* LoadGameDialog.xaml.cs

* SavedGameHeader.cs ( Header checks the save game version if the file is compatible)

== Files ==

* ClientSettings.xaml

== Important Code Files ==

* ClientModule.cs ... starts the App and 'ends' at StartScreen..

* ClientOptions ... like Music Volume

* GameEngine.cs ... start for example a SinglePlayerGame or MultiPlayerGame
** Do....

* GameOptions like GalaxySize

* SupremacyCore\Game\CivilizationManager.cs ... handling Empires and other Civilizations

=== Sector ===
** contains a System, Nebulas are also a System
** a system might contain a Colony (which is a inhabitanted system)
** a colony might have Planets (and them moons)

* Colony.cs ... doing stuff for a single Colony

=== Civilization ===

* CivilizationManager.cs > contains the civilizations (current credits and more)
* Civilization.cs > only stuff from Civilization.xaml like Name

=== SAVELOAD ===

* SavedGameHeader.cs = Header (Name of saved file, version nummer (!!) and more)
* SavedGameManager.cs = saving Game

UI

2020-11-22T15:18:23Z

Reginald: /* TextBrush */

== Intro ==

some words to UI....

* starting a game starts every of the five screens at the same time ! (Map/System/...)

* inside the screens it is mostly jumping to the last selected tab (e.g. System: Production or Shipbuilding)
** these complete screens are done by different parts:
***left top: Template like SystemInfo
***left bottom: Template like BuildQueue
***right: ProductionScreen
***right bottom: Planets...

== Theme ==

* Themes are appearance of each Empire's UI.

Common stuff is content of Global.xaml

Empire's themes are defined in Shared.xaml

=== Border ===

* LCARS_BorderStyle (e.g. Chat-Window)
* LCARS_ThinBorderStyle (e.g. Summary)

=== Button ===

* GameButton // e.g. Economy
* LCARS_BorderButtonStyle
* LCARS_BorderToggleButtonStyle" // e.g. CHAT Button in GalaxyMapView
* LCARS_SimpleButtonStyle // e.g. REDEPLOY-Button
* LCARS_SimpleToggleButtonStyle

* Default = IsEnable = Current Selection = GREEN = LCARS_Dom3Gradient_Bottom_Top
* MouseOver = PINK GRADIENT = LCARS_Dom2Gradient_Bottom_Top
* IsPressed = PINK = LCARS_Dom1Gradient_Bottom_Top
* IsChecked

=== TextBrush ===

Usage: {StaticResource HeaderTextBrush}
*DefaultTextBrush"
*HeaderTextBrush"
*LCARS_HeaderBrush"
*DisabledTextBrush"
*SelectionBrush"
*BorderBrush"

----

* ControlTextForegroundBrushKey

* HeaderTextForegroundBrushKey

* DefaultTextForegroundBrushKey

* ImageBorderBrushKey

* DisabledTextForegroundBrushKey

* HighlightBrushKey

* InactiveHighlightBrushKey

* AlertTextForegroundBrushKey

* HighlightBrushKey

== Colour ==

=== LightBlue ===
* Research
* Dilithium

=== Red ===
* Deuterium

=== Silver ===
* Intelligence

=== Gray ===
* Duranium = Rax Materials

=== Goldrod ===
* Energy
* Total Population in EmpireInfo

=== Borg ===

*LCARS_GreenTextBrush

*DarkGreen

== ClientApp ==

* SupremacyClient\ClientApp.xaml.cs - this is the main app - starting at "EntryPoint"
* SupremacyClient\ClientWindow.xaml.cs - this is the main window

== MultiplayerSetupScreen ==

* MultiplayerSetupScreen.xaml + MultiplayerSetupScreen.xaml.cs

== SUMMARY ==

SitReps are a part of CivManager of a Civilization...

* SitRepEntry.cs (contains a Global SitRep-Function and special ones)

* SitRepDialog.xaml ( = Dialog )
* SitRepDialog.xaml.cs ( Logic for Dialog = Filter on/off )

== Context Menu ==

* SupremacyClient\themes\Dominion\GameContextMenu.xaml
* GalaxyScreenView.xaml

== Bottom View ==

various parts are filled in

=== PlanetsViewRegion ===

* \SupremacyUI\StarSystemPanel.cs

=== AssignedShipListRegion ===

* AssignedShipListRegion

=== PART_ChatPanel ===

* PART_ChatPanel

== F1 ==

* GalaxyScreenView.xaml (Race specific)

* Expander EmpireInfo > EmpireInfoView.xaml

== F2 ==

=== Right ===

* SystemProductionPanel.cs (without any xaml file !)

=== Left ===

* ColonyHandlingListView.cs

== F3 ==

* NewDiplomacyScreen.xaml + NewDiplomacyScreen.xaml.cs
* DiplomacyScreenViewModel.cs
* \SupremacyCore\Diplomacy\DiplomacyHelper.cs
* DiplomatAI.cs
* ForeignPowerViewModel.cs

* DiplomacyMessageViewModel.cs and more

* AcceptProposalVisitor.cs
* RejectProposalVisitor.cs

== F4 ==

== F5 ==

* AssetsScreen.xaml + AssetsScreen.xaml.cs
** TAB: Colonies -> a) Headline directly in AssetsScreen.xaml
** TAB: Colonies -> b) ColonyList ="{Binding Path=Colonies} -> SystemListItem.xaml (+.cs)
*
** TAB: SpyReport -> b)

* AssetsScreenPresentationModel.cs

* ActiveAgreementViewModel.cs

== F11 ==

* File:CheatMenu.xaml + File:CheatMenu.xaml.cs

== CTRL+F11 ==

* FakeDialog.xaml + FakeDialog.xaml.cs

== ClientSettings ==

* ClientSettings.cs - stuff is written into file > ClientSettings.xaml

=== CTRL+O ===

* ClientOptionsDialog.xaml + ClientOptionsDialog.xaml.cs

==== File:ClientOptionsDialog.xaml ====

* File:ClientOptionsDialog.xaml

=== CTRL+Z ===

* ClientTracesDialog.xaml + ClientTracesDialog.xaml.cs

==== File:TracesOptionsPage.xaml ====

* File:TracesOptionsPage.xaml + File:TracesOptionsPage.xaml.cs

== GameOptionsPanel ==

at Starting

* GameOptionsPanel.xaml + GameOptionsPanel.xaml.cs

== LoadGameDialog ==

* LoadGameDialog.xaml.cs

* SavedGameHeader.cs ( Header checks the save game version if the file is compatible)

== Files ==

* ClientSettings.xaml

== Important Code Files ==

* ClientModule.cs ... starts the App and 'ends' at StartScreen..

* ClientOptions ... like Music Volume

* GameEngine.cs ... start for example a SinglePlayerGame or MultiPlayerGame
** Do....

* GameOptions like GalaxySize

* SupremacyCore\Game\CivilizationManager.cs ... handling Empires and other Civilizations

=== Sector ===
** contains a System, Nebulas are also a System
** a system might contain a Colony (which is a inhabitanted system)
** a colony might have Planets (and them moons)

* Colony.cs ... doing stuff for a single Colony

=== Civilization ===

* CivilizationManager.cs > contains the civilizations (current credits and more)
* Civilization.cs > only stuff from Civilization.xaml like Name

=== SAVELOAD ===

* SavedGameHeader.cs = Header (Name of saved file, version nummer (!!) and more)
* SavedGameManager.cs = saving Game

Data

2020-11-01T12:30:45Z

Reginald: /* CivilizationManager */

== Intro ==

== CivilizationManager ==

in code often "civManager"

* all out of [[#Civilization]] and managed data (see next)

* Owner (for minors)
* Colonies (counted)
* Population (total)

* Credits
* Credits last Turn
* Maintenance
* Tax
* Trade Route Income (total?)
* Empire Morale
* Research (Percent + Values in total + current production)
* Intel Production (total)
* Intel Defense
* Intel Attack
* Dilithium total / last turn
* Deuterium total / last turn
* Duranium total / last turn

== Civilization ==

contains FIX data out of Civilizations.xml like (Federation as example)
* Race>HUMANS
* ShortName>Federation
* LongName>United Federation of Planets
* ShortNameArtCap>The Federation
* ShortNameArtDir>the Federation
* ShortNameFromThe>from the Federation
* ShortNameToThe>to the Federation
* LongNameArtCap>The United Federation of Planets
* LongNameArtDir>the United Federation of Planets
* LongNameFromThe>from the United Federation of Planets
* LongNameOfTheGreater>of the greater United Federation of Planets</LongNameOfTheGreater>
* DiplomacyReport> ...
* HomeSystemName>Sol
* Color>Blue
* HomeQuadrant>Alpha
* CivilizationType>Empire
* Traits>Compassion,Materialistic,Peaceful
* IndustryToCreditsConversionRatio>50
* TechCurve>TechCurve6
* ShipPrefix>USS

Data

2020-11-01T12:04:25Z

Reginald: Created page with "== Intro == == CivilizationManager == in code often "civManager" * all out of #Civilization and managed data (see next) * Owner (for minors) * Colonies (counted) * Po..."

== Intro ==

== CivilizationManager ==

in code often "civManager"

* all out of [[#Civilization]] and managed data (see next)

* Owner (for minors)
* Colonies (counted)
* Population (total)

* Credits
* Credits last Turn
* Maintenance
* Tax
* Trade Route Income (total?)
* Empire Morale
* Research
* Intel Production (total)
* Intel Defense
* Intel Attack
* Dilithium total / last turn
* Deuterium total / last turn
* Duranium total / last turn

== Civilization ==

contains FIX data out of Civilizations.xml like (Federation as example)
* Race>HUMANS
* ShortName>Federation
* LongName>United Federation of Planets
* ShortNameArtCap>The Federation
* ShortNameArtDir>the Federation
* ShortNameFromThe>from the Federation
* ShortNameToThe>to the Federation
* LongNameArtCap>The United Federation of Planets
* LongNameArtDir>the United Federation of Planets
* LongNameFromThe>from the United Federation of Planets
* LongNameOfTheGreater>of the greater United Federation of Planets</LongNameOfTheGreater>
* DiplomacyReport> ...
* HomeSystemName>Sol
* Color>Blue
* HomeQuadrant>Alpha
* CivilizationType>Empire
* Traits>Compassion,Materialistic,Peaceful
* IndustryToCreditsConversionRatio>50
* TechCurve>TechCurve6
* ShipPrefix>USS

Source Code

2020-10-31T13:28:51Z

Reginald: /* MessageBox (Windows Style) */

== Source Code ==

http://guganeshan.com/blog/setting-up-git-and-tortoisegit-with-bitbucket-step-by-step.html

=== official ===

* code is now at https://github.com/BotF2/BotF2.git

*last source code https://bitbucket.org/mstrobel/supremacy/overview (it's in C#, also named CSharp. [[#Visual Studio]] is used for coding.)
**Mike's Post: build in [http://www.microsoft.com/downloads/dlx/en-us/ThankYou.aspx?FamilyID=75568AA6-8107-475D-948A-EF22627E57A5 VS2010] with .NET 4.0. You may need the [http://en.csharp-online.net/Download_Free_Microsoft_Visual_CSharp_.NET#Download_Microsoft_Visual_Studio_Async_Community_Technology_Preview_.28CTP.29 C# Async CTP]. http://bote2.square7.ch/forum/viewtopic.php?p=70790#p70790
**http://bote2.square7.ch/forum/viewtopic.php?p=70781#p70781
*** Supremacy.Game.GameEngine is where you'll find most of the game logic. That's where most of the turn processing happens.
*** The SupremacyCore project is where you'll find the foundation of the game.
*** SupremacyService is just the game server (all the important bits it interacts with are in SupremacyCore).
*** SupremacyClientComponents is UI infrastructure.
*** SupremacyUI and SupremacyWPF are older UI infrastructure stuff, much of which has been phased out and replaced by newer and better stuff in SupremacyClientComponents. The most interesting stuff in SupremacyUI is GalaxyGridPanel, which draws the galactic map. It also has the spinning planet views.
*** Supremacy.Xna is where the XNA/3D stuff is located--it's not used heavily yet, but it has some effects for the invasion screen, a newer star renderer, a 3D spinning ship renderer, etc.
*** Supremacy.Scripting is an expression language parser/compiler.
*** SupremacyClient is the main graphical client and has most of the game screen implementations.

*old source code can be taken from here: http://supremacy.codeplex.com/ (last upload from MStrobel at 03.01.2011)

==== ClientContext vs AppContext ====

taken from https://bitbucket.org/kflanagan/supremacydev/commits/0d562ce676425cd5da19cfdbcf1b6c18c7d0d135

*IClientContext is used by SupremacyCore to interface clients participating on a game, both local and over network. The IClientContext further includes an interface to IGameContext which gives access to the game data itself inside the '''SupremacyClient app'''
*However there should be an option to also include local properties not known to the Core, which is why this is done alternatively another context would have to be introduced for local data, but then still all the client code would have to be updated to make use of it

==== .XAML files ====

In Windows Presentation Foundation (WPF), a windows app framework used by Supremacy, XAML forms a user interface markup language to define UI elements, data binding, events, and other features.

Info resources:

*MS Article: [https://msdn.microsoft.com/en-us/library/ms745683(v=vs.110).aspx XAML Styling and Templating]

*Youtube video: [https://www.youtube.com/watch?v=0qE5hyuU9hE Introduction to XAML] (26min)

== Bitbucket ==

*https://confluence.atlassian.com/display/BITBUCKET/Maintaining+a+Mercurial+Repository

== Changes ==

see [[ChangeLog|here]] or https://bitbucket.org/mstrobel/supremacy/commits/branch/default

=== 2016 ===

==== XAML ====

*January 2016 [Planned]: Hope to get Major Race specific UI build through use of generic XAML files.
* ClientApp.xaml.cs has the code to direct UI to race specific folders of xaml files in SupremacyClient/themes/{0}

Looking at SystemScreen.xaml, Global.xaml and ClientModules.cs in Themes/SupremacyClient
See also generic.xaml in SupremacyClientComponents/Themes/InfoCard Theme.xaml Default.xaml Icons.xaml ClientApp.xaml.cs SystemScreen.xaml

1/17/16: Found that Mikes code in ClientApp.xaml.cs will already select for Major race. Need new folders for each major race in SupremacyClient/themes/(major race), edit paths to Resources in the .xaml files found in each races set of .xaml files. File names in SupremacyClient/themes/(major race) are not unique but content in Resources is. Now you can edit files in Resources for unique UI.

2/13/16:

<Polygon
Points="300,200 400,125 400,275 300,200"
Stroke="Purple"
StrokeThickness="2">
<Polygon.Fill>
<SolidColorBrush Color="Blue" Opacity="0.4"/>
</Polygon.Fill>
</Polygon>

Makes a left pointing triangle, purple outline and blue body

=== 2015 ===

*'''Animation.cs''' (animation of opening screen): This is where we can set the number of images, frames, and the rate they play at, currently all images in 30 seconds. We may want that to run faster. The images you will make for the ship de-cloaking will be located in Resources / Images / Animation.
* \supremacyclient\'''ClientModule.cs''':
**Found a place to add the right mouse click instructions for the Panel Access Menu. A thing called the statusWindow held the text "loading" while you wait for a game to load. Added the information there for new players

*FMOD is partly replace by AudioEngine.cs and others - just find it out

=== 2014 ===

== some code ==

for Theme and UI see >> '''[[Theme]]'''

=== miscellaneous ===

*Mainline\SupremacyClient\GameContextMenu.cs

*\Mainline\SupremacyUI\SystemProductionPanel.cs

*\Mainline\SupremacyCore\Orbitals\FleetOrders.cs -> all items inside a sector

*Mainline\SupremacyClient\GameContextMenu.cs (Access Popup Menu - or use F1 to F5)

*\Mainline\SupremacyClientComponents\Controls\InfoCard\InfoCard.cs (-> Tooltips ??)
**\Mainline\SupremacyClient\themes\Federation\InfoCard.xaml -> <Setter Property="Width" Value="500" /> (BEFORE: 250)

*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyPlanetaryBuildQueueView.xaml - Colonies Screen Content

*\Mainline\SupremacyCore\Universe\Colony.cs
*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyStructureListView.xaml
**Size of this area: 720 x 240

*\Mainline\SupremacyClient\Views\GalaxyScreen\TaskForceListView.xaml

=== Version Number ===

Look for version number control in AssemblyInfo.cs

your hard disk code folder BotF2\SupremacyClient\Properties\AssemblyInfo.cs

---
example code: (put in your current star date)

*[assembly: AssemblyVersion("2018.11.20.0")]
*[assembly: AssemblyFileVersion("2018.11.20.0")]

=== Ships ===

*\Fleets.cs
*\FleetOrder.cs (without a "s" - beware of it)
*\FleetOrders.cs

*\mainline\supremacyclientcomponents\views\galaxyscreen\galaxyscreenpresenter.cs TaskForcesList

==== Building Ships ====

*Cancelling -> Breakpoint at Line 185 at OnShipyardBuildProjectsChanged() \Mainline\SupremacyClientComponents\Views\ColonyScreen\ColonyScreenPresentationModel.cs

=== Sounds ===

*\Mainline\SupremacyClient\AudioEngine.cs (for Music), for Sounds >> SoundPlayerAction is used (search for \Resources\UI\Federation\SoundsButtonClick.wav)
*and in \Mainline\SupremacyClientComponents\Views\SystemAssaultScreen\SystemAssaultScreenViewModel.cs -> Uri is used (e.g. CombatLaser.wav)

=== Galaxy Generator ===

*\Mainline\SupremacyCore\Universe\GalaxyGenerator.cs

=== Values ===
*CivID: 0 = Federation...

=== TurnPhase ===

WaitOnPlayers = 0,
PreTurnOperations,
ResetObjects,
FleetMovement,
Combat,
PopulationGrowth,
PersonnelTraining,
Research,
Scrapping,
Maintenance,
ShipProduction,
Production,
Trade,
Morale,
MapUpdates,
PostTurnOperations,
SendUpdates,
Diplomacy,
WaitOnAIPlayers

=== older list ===

{|class="wikitable sortable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |where
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Folder
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |File
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Function
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Date
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Description
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameContext.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
initialising game
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|
Raw Materials, Deuterium, Dilithium is collected cross over all colonies and used by all colonies
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoShipProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|

|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Combat
|style=text-align:center|InvasionArena.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
SystemAssault
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Orbital
|style=text-align:center|Shipyard.cs
|style=text-align:center|GetBuildOutput(int slot)
|style=text-align:center| [https://bitbucket.org/Bloodwurm/BotF2dev/commits/1aafc8f6e47e9e3b9c20de79f2d02f197c023d63 2014-01-15]
|style=text-align:left|
just selects output (active?) and bonus (BonusType.PercentShipBuilding), since 2014-01-15 also case PopulationRatio or IndustryRatio
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|GetProductionOutput(ProductionCategory category)
|style=text-align:center|
|style=text-align:left|
see last line, too !
*Food: minimum 10
*Research:
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*Industry: '''minimum 10 !'''
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*last line: return ((int)(baseOutput + (baseOutput * modifier.Efficiency)) + modifier.Bonus);
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasFoodBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasFoodBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasEnergyBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasEnergyBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-ClientComp
|style=text-align:center|Views\GalaxyScreen
|style=text-align:center|GalaxyScreenView.cs
|style=text-align:center|GalaxyScreenView()
|style=text-align:center|
|style=text-align:left|GalaxyView Hotkeys Definition (see [[Hotkey]]s)
|style=text-align:left|
|style=text-align:left|

|}

== Botf2-coding-practice ==

*http://star-trek-supremacy.proboards.com/thread/349/botf2-coding-practice (intern)

*prepare:
**...we are using SourceTree, provided by bitbucket (another option: TortoiseHg with Mercurial - to access the supremacy code repository http://tortoisehg.bitbucket.org/)
**PuTTYgen - to generate a ssh key to allow using ssh protocol instead of slow https http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
***or use C:\Program Files (x86)\Atlassian\SourceTree\tools\putty..puttygen.exe....generate a key (using a phrase is not neccessary)
***copy the public key (4-5 lines) into your bitbucket account/profile under SSH Keys, label it with any title and CopyPaste
**we are using Visual Studio Community 2013 Update 4 (select the Community Version) https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
**we are not(!) using Visual Studio Community 2015 RC - to compile the code (ISO is recommend)....still need to check if Supremacy code compiles with it, so instead we might need to depend on VS2013 http://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs....for VS 2015 we read to create a new project, import Supremacy and go through all the issues
**you also need to have an account on http://bitbucket.org
**and you should have Skype installed to participate in the meetings we have

*when you attempt to clone by ssh instead of https, check the following tutorial: http://confluence.atlassian.com/display/BITBUCKET/Set+up+SSH+for+Mercurial

*here some simple text editors useful to edit stuff like xml files, just pick the one you prefer they all are great:
**http://www.sublimetext.com/
**http://www.contexteditor.org/index.php
**http://notepad-plus-plus.org/ (used by reg atm)

== SourceTree ==

*Download >> https://www.sourcetreeapp.com/?v=win (or while cloning...use the link below blue Clone Button)

*Tools: 3rd point: OPTIONS

*SSH Client Configuration:
**SSH Key: c:\....\ReginaldPutty.ppk
**SSH Client: (IMPORTANT) PuTTY/Link (not SSH !!)
**automatically start: yes

== Visual Studio ==

It's possible (and standard) to compile the game with Visual Studio. No further stuff of programs is needed, except matching Resources folder. Mention that the compiled exe is then in \Mainline\bin\Debug (or \Release).

=== Visual C++ Library ===

IMPORTANT: As Microsoft no longer provides Visual C++ Library as standard installed component ...don't forget to select or install this manually! In VS you can recognize it if \Supremacy Native is unload (sign is greyed out a little bit)

==== SupremacyNative ====

SupremacyNative is C++ coded. Sometimes there are some problems with it https://developercommunity.visualstudio.com/content/problem/312852/internal-compiler-error-in-vs158-msc1cpp-line-1518.html

=== VS2019 ===

* meanwhile we are on VS 2019 Community version https://www.visualstudio.com/downloads

=== VS2017 ===

In May 2017 we're trying to change to VS 2017 Community version https://www.visualstudio.com/downloads

*you might want to change language at TOOLS > OPTIONS > ENVIROMENT > INTERNATIONAL SETTINGS

* first make a clean !!, maybe for each single project (10 of 10)

* SOLUTION EXPLORER - right mouse click - retarget (in the middle) - select newest versions

* (this should be only needed once and should be uploaded to Repository by one guy) SupremacyClient > Set as start Project

*after cleaning maybe use REBUILD

for more see >> [[#Tools|here]]

=== VS2015 ===

since April 2016 we're using VS 2015

*Visual Studio '''Community''' 2015 RC - to compile the code (ISO is recommend) ... still need to check if Supremacy code compiles with it, so instead we might need VS2013. NEW: we try to go to VS 2015 now.
https://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs - you need the "Community" Version, currently (Apr 2016) version "Update 2"

==== VS 2015 Update 3 ====

*says it does uninstall Update 2
*needs update to 33 GB to install (only if every is selected) - seems to need some hours...

=== old VS ===

*Visual Studio Community 2013 (Community version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2012 (Express version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2008 (German) http://www.microsoft.com/de-de/download/details.aspx?id=13276

=== Tools ===

*Indent Guides https://visualstudiogallery.msdn.microsoft.com/e792686d-542b-474a-8c55-630980e72c30 Adds vertical lines at each indent level.

* Vertical tabs https://marketplace.visualstudio.com/items?itemName=VisualStudioProductTeam.ProductivityPowerPack2017

*PowerShell Tools für VS 2015

=== Tips ===
*TOOLS > OPTIONS > ENVIRONMENT > Color theme -> Black

*TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Detect when file is changed outside... -> Yes
**TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Reload modified files... -> Yes

*DEBUG > OPTIONS > PROJECTS... > BUILD AND RUN > when code=project is changed="out of date" > "Always Build" (checkbox "only build ...on Run" is marked)
**https://www.vb-paradise.de/index.php/Thread/47935-Code-bei-Klick-auf-Debugging-starten-kompilieren-wenn-er-sich-ge%C3%A4ndert-hat/

*TOOLS > OPTIONS > TEXT EDITOR > ALL LANGUAGES > Line Number (activate for all)

*DEBUG > SUPREMACY CLIENT PROPERTIES (last) > DEBUG > Start project > Command line arguments: "-aiexplore -SAVEDGAME:auto" (if you save in Supremacy manually a game with name "auto" (independent from game's "(autosave)", this manually saved game can be loaded at startup.
**"-aiexplore" isn't necessary. For more see [[Command line parameter]]
**if working for example on Cardassian UI just save Cardassian as "auto".
**when you want to change to Klingons, just retire and start Klingons. If you want to work steady on Klingons, save a Klingon's game with auto.
**if you want to start a new game steady, just go Command line arguments (see above) and change the filename to an unused one like "-SAVEDGAME:auto123"

*activate Toolbar BUILD by right mouse click on Toolbar line

* Tools -> Options -> Debugging -> Output Window -> Module Load Messages -> Off

==== Editor ====
we're using some different editors
*one option is to drag'n'drop files like xml to Visual Studio
*sometimes we use Notepad++ https://notepad-plus-plus.org/download with Extension Compare (PLUGINS > PLUGIN MANAGER > SHOW P-Manager > "Compare" ...install
*for a black style we use Sublime http://www.sublimetext.com/2

==== Screenshot ====

*reg likes Greenshot http://getgreenshot.org/
**puts an icon into task bar. There: > PREFERENCES
***PREFERENCES > GENERAL: reg uses for "Capture region" CRTL+PRNT (and no other hotkey)
***PREFERENCES > OUTPUT: define a folder at "Storage location" and a standard file type (default is *.png)
***PREFERENCES > DESTINATION: (reg's settings)
****- turn off "Select destination dymnamically"
****- open in image editor
****- copy to clipboard
**Usage:
***press Hotkey and make Screenshot
***paste immediately anywhere OR
***work on it inside Greenshot (give red circles or mark up in any colour), give numbers, obfuscate and more
***save or save as jpg or print

== Compiling ==

if you have an error with "Glyphs.xaml", than make sure you have copied \Resources MANUALLY into the output folders - this was changed in 2015. The output folder depends on compiling method "Debug" or "Release", it is
*for DEBUG _: (YourRepositoryFolder)\Mainline\bin\'''Debug\Resources''' or
*for RELEASE: (YourRepositoryFolder)\Mainline\bin\'''Release\Resources'''

it's creating:
*1> Supremacy.Scripting -> %path_repo%\bin\Debug\lib\Supremacy.Scripting.dll
*2> SupremacyCore -> %path_repo%\bin\Debug\lib\SupremacyCore.dll
*3> Supremacy.Xna -> %path_repo%\bin\Debug\lib\Supremacy.Xna.dll
*4> SupremacyClientComponents -> %path_repo%\bin\Debug\lib\SupremacyClientComponents.dll
*5> SupremacyWPF -> %path_repo%\bin\Debug\lib\SupremacyWPF.dll
*6> SupremacyService -> %path_repo%\bin\Debug\lib\SupremacyService.dll
*7> SupremacyUI -> %path_repo%\bin\Debug\lib\SupremacyUI.dll

== Visual C# ==

build in Visual Studio

<img>http://botf2.square7.ch/wiki-files/images/VS2015.jpg</img>

== SunBurn ==

SunBurn is on hold for now. Kenneth was working sometimes with SunBurn...this might be a site for this http://channel9.msdn.com/coding4fun/blog/No-need-for-sunscreen-you-want-this-SunBurn-SunBurn-v2-RTMs-including-the-free-SunBurn-Framework-Edi

*http://en.wikipedia.org/wiki/List_of_game_engines

== .Net ==

you should use latest [http://www.microsoft.com/net .Net-version] (2014: version 4.5.1)

== XNA ==

"Could not load file or assembly 'Microsoft.Xna.Framework.dll' or one of its dependencies. The specified module could not be found."

*suggestion by reg: go to \Resources\Models and rename the "Models"-folder to "Models-SetOffline" or something else (if building a ship no model is shown -as it is to most of the ships- but otherwise the game could work fine)

This suggests the problem is with your XNA installation. The game uses XNA to display the 3D ship models in the shipyard. There's no way to disable the models so XNA wouldn't be needed. So to be able to play the game, i'd advise to uninstall XNA, then install the latest version.

XNA 3.1 (this one you need in any case): http://www.microsoft.com/en-us/download/details.aspx?id=15163

XNA 4.0 Download link: http://www.microsoft.com/en-gb/download/details.aspx?id=20914

== Try ==

(for boolean)

try
{
return true;
}
catch (Exception e)
{
var errors = new System.Collections.Concurrent.ConcurrentStack<Exception>();
errors.Push(e);
return false;
}
finally
{
xxx;
}
;

== Contexts ==

*AppContext (programm running)
*GameContext.Current (Game started - so after StartScreen)
*PlayerContext.Current

== Text ==
=== en.txt ===
* XAML example: Text="{s:StringResource EMPIRES_HEADER}"
* string _text = String.Format(ResourceManager.GetString("KEY_IN-EN_TXT"),parameter1, parameter2;

== LocalPlayer ==

*AppContext.LocalPlayer (just inside XAML-code files ??)

== Civilization ==

just the data out of Civilization.xml ... for more see [[#CivilizationManager]]

== CivilizationManager ==

CivilizationManager holds all the data like amount of credits, diplomacy, sitreps and more

*GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

== GameLog ==

if not available, try "Quick actions" -> using Supremacy.Utility;

GameLog.Core.GameData.DebugFormat("Turn {0};xx=;{1};xx=;{2};xx={3};xx={4};xx={5};xx={6};xx={7};xx={8};xx={9};"
, GameContext.Current.TurnNumber
, xx
, xx
);

== Dictionary ==

private static Dictionary<string, bool> _acceptRejectDictionary = new Dictionary<string, bool> { { "98", false } };

== MessageBox (Windows Style) ==

MessageBox.Show("Borg turned into Expanded", "WARNING", MessageBoxButton.OK);

== MessageDialog (Supremacy Style) ==

var result = MessageDialog.Show("Borg turned into Expanded", MessageDialogButtons.YesNo);

== SoundPlaying ==

* _soundPlayer.PlayFile("Resources/SoundFX/ChatMessage.wav");

UI

2020-10-31T10:34:36Z

Reginald: /* SUMMARY */

== Intro ==

some words to UI....

* starting a game starts every of the five screens at the same time ! (Map/System/...)

* inside the screens it is mostly jumping to the last selected tab (e.g. System: Production or Shipbuilding)
** these complete screens are done by different parts:
***left top: Template like SystemInfo
***left bottom: Template like BuildQueue
***right: ProductionScreen
***right bottom: Planets...

== Theme ==

* Themes are appearance of each Empire's UI.

Common stuff is content of Global.xaml

Empire's themes are defined in Shared.xaml

=== Border ===

* LCARS_BorderStyle (e.g. Chat-Window)
* LCARS_ThinBorderStyle (e.g. Summary)

=== Button ===

* GameButton // e.g. Economy
* LCARS_BorderButtonStyle
* LCARS_BorderToggleButtonStyle" // e.g. CHAT Button in GalaxyMapView
* LCARS_SimpleButtonStyle // e.g. REDEPLOY-Button
* LCARS_SimpleToggleButtonStyle

* Default = IsEnable = Current Selection = GREEN = LCARS_Dom3Gradient_Bottom_Top
* MouseOver = PINK GRADIENT = LCARS_Dom2Gradient_Bottom_Top
* IsPressed = PINK = LCARS_Dom1Gradient_Bottom_Top
* IsChecked

=== TextBrush ===

* ControlTextForegroundBrushKey

* HeaderTextForegroundBrushKey

* DefaultTextForegroundBrushKey

* ImageBorderBrushKey

* DisabledTextForegroundBrushKey

* HighlightBrushKey

* InactiveHighlightBrushKey

* AlertTextForegroundBrushKey

* HighlightBrushKey

== Colour ==

=== LightBlue ===
* Research
* Dilithium

=== Red ===
* Deuterium

=== Silver ===
* Intelligence

=== Gray ===
* Duranium = Rax Materials

=== Goldrod ===
* Energy
* Total Population in EmpireInfo

=== Borg ===

*LCARS_GreenTextBrush

*DarkGreen

== ClientApp ==

* SupremacyClient\ClientApp.xaml.cs - this is the main app - starting at "EntryPoint"
* SupremacyClient\ClientWindow.xaml.cs - this is the main window

== MultiplayerSetupScreen ==

* MultiplayerSetupScreen.xaml + MultiplayerSetupScreen.xaml.cs

== SUMMARY ==

SitReps are a part of CivManager of a Civilization...

* SitRepEntry.cs (contains a Global SitRep-Function and special ones)

* SitRepDialog.xaml ( = Dialog )
* SitRepDialog.xaml.cs ( Logic for Dialog = Filter on/off )

== Context Menu ==

* SupremacyClient\themes\Dominion\GameContextMenu.xaml
* GalaxyScreenView.xaml

== Bottom View ==

various parts are filled in

=== PlanetsViewRegion ===

* \SupremacyUI\StarSystemPanel.cs

=== AssignedShipListRegion ===

* AssignedShipListRegion

=== PART_ChatPanel ===

* PART_ChatPanel

== F1 ==

* GalaxyScreenView.xaml (Race specific)

* Expander EmpireInfo > EmpireInfoView.xaml

== F2 ==

=== Right ===

* SystemProductionPanel.cs (without any xaml file !)

=== Left ===

* ColonyHandlingListView.cs

== F3 ==

* NewDiplomacyScreen.xaml + NewDiplomacyScreen.xaml.cs
* DiplomacyScreenViewModel.cs
* \SupremacyCore\Diplomacy\DiplomacyHelper.cs
* DiplomatAI.cs
* ForeignPowerViewModel.cs

* DiplomacyMessageViewModel.cs and more

* AcceptProposalVisitor.cs
* RejectProposalVisitor.cs

== F4 ==

== F5 ==

* AssetsScreen.xaml + AssetsScreen.xaml.cs
** TAB: Colonies -> a) Headline directly in AssetsScreen.xaml
** TAB: Colonies -> b) ColonyList ="{Binding Path=Colonies} -> SystemListItem.xaml (+.cs)
*
** TAB: SpyReport -> b)

* AssetsScreenPresentationModel.cs

* ActiveAgreementViewModel.cs

== F11 ==

* File:CheatMenu.xaml + File:CheatMenu.xaml.cs

== CTRL+F11 ==

* FakeDialog.xaml + FakeDialog.xaml.cs

== ClientSettings ==

* ClientSettings.cs - stuff is written into file > ClientSettings.xaml

=== CTRL+O ===

* ClientOptionsDialog.xaml + ClientOptionsDialog.xaml.cs

==== File:ClientOptionsDialog.xaml ====

* File:ClientOptionsDialog.xaml

=== CTRL+Z ===

* ClientTracesDialog.xaml + ClientTracesDialog.xaml.cs

==== File:TracesOptionsPage.xaml ====

* File:TracesOptionsPage.xaml + File:TracesOptionsPage.xaml.cs

== GameOptionsPanel ==

at Starting

* GameOptionsPanel.xaml + GameOptionsPanel.xaml.cs

== LoadGameDialog ==

* LoadGameDialog.xaml.cs

* SavedGameHeader.cs ( Header checks the save game version if the file is compatible)

== Files ==

* ClientSettings.xaml

== Important Code Files ==

* ClientModule.cs ... starts the App and 'ends' at StartScreen..

* ClientOptions ... like Music Volume

* GameEngine.cs ... start for example a SinglePlayerGame or MultiPlayerGame
** Do....

* GameOptions like GalaxySize

* SupremacyCore\Game\CivilizationManager.cs ... handling Empires and other Civilizations

=== Sector ===
** contains a System, Nebulas are also a System
** a system might contain a Colony (which is a inhabitanted system)
** a colony might have Planets (and them moons)

* Colony.cs ... doing stuff for a single Colony

=== Civilization ===

* CivilizationManager.cs > contains the civilizations (current credits and more)
* Civilization.cs > only stuff from Civilization.xaml like Name

=== SAVELOAD ===

* SavedGameHeader.cs = Header (Name of saved file, version nummer (!!) and more)
* SavedGameManager.cs = saving Game

Source Code

2020-10-24T10:54:13Z

Reginald: /* GameLog */

== Source Code ==

http://guganeshan.com/blog/setting-up-git-and-tortoisegit-with-bitbucket-step-by-step.html

=== official ===

* code is now at https://github.com/BotF2/BotF2.git

*last source code https://bitbucket.org/mstrobel/supremacy/overview (it's in C#, also named CSharp. [[#Visual Studio]] is used for coding.)
**Mike's Post: build in [http://www.microsoft.com/downloads/dlx/en-us/ThankYou.aspx?FamilyID=75568AA6-8107-475D-948A-EF22627E57A5 VS2010] with .NET 4.0. You may need the [http://en.csharp-online.net/Download_Free_Microsoft_Visual_CSharp_.NET#Download_Microsoft_Visual_Studio_Async_Community_Technology_Preview_.28CTP.29 C# Async CTP]. http://bote2.square7.ch/forum/viewtopic.php?p=70790#p70790
**http://bote2.square7.ch/forum/viewtopic.php?p=70781#p70781
*** Supremacy.Game.GameEngine is where you'll find most of the game logic. That's where most of the turn processing happens.
*** The SupremacyCore project is where you'll find the foundation of the game.
*** SupremacyService is just the game server (all the important bits it interacts with are in SupremacyCore).
*** SupremacyClientComponents is UI infrastructure.
*** SupremacyUI and SupremacyWPF are older UI infrastructure stuff, much of which has been phased out and replaced by newer and better stuff in SupremacyClientComponents. The most interesting stuff in SupremacyUI is GalaxyGridPanel, which draws the galactic map. It also has the spinning planet views.
*** Supremacy.Xna is where the XNA/3D stuff is located--it's not used heavily yet, but it has some effects for the invasion screen, a newer star renderer, a 3D spinning ship renderer, etc.
*** Supremacy.Scripting is an expression language parser/compiler.
*** SupremacyClient is the main graphical client and has most of the game screen implementations.

*old source code can be taken from here: http://supremacy.codeplex.com/ (last upload from MStrobel at 03.01.2011)

==== ClientContext vs AppContext ====

taken from https://bitbucket.org/kflanagan/supremacydev/commits/0d562ce676425cd5da19cfdbcf1b6c18c7d0d135

*IClientContext is used by SupremacyCore to interface clients participating on a game, both local and over network. The IClientContext further includes an interface to IGameContext which gives access to the game data itself inside the '''SupremacyClient app'''
*However there should be an option to also include local properties not known to the Core, which is why this is done alternatively another context would have to be introduced for local data, but then still all the client code would have to be updated to make use of it

==== .XAML files ====

In Windows Presentation Foundation (WPF), a windows app framework used by Supremacy, XAML forms a user interface markup language to define UI elements, data binding, events, and other features.

Info resources:

*MS Article: [https://msdn.microsoft.com/en-us/library/ms745683(v=vs.110).aspx XAML Styling and Templating]

*Youtube video: [https://www.youtube.com/watch?v=0qE5hyuU9hE Introduction to XAML] (26min)

== Bitbucket ==

*https://confluence.atlassian.com/display/BITBUCKET/Maintaining+a+Mercurial+Repository

== Changes ==

see [[ChangeLog|here]] or https://bitbucket.org/mstrobel/supremacy/commits/branch/default

=== 2016 ===

==== XAML ====

*January 2016 [Planned]: Hope to get Major Race specific UI build through use of generic XAML files.
* ClientApp.xaml.cs has the code to direct UI to race specific folders of xaml files in SupremacyClient/themes/{0}

Looking at SystemScreen.xaml, Global.xaml and ClientModules.cs in Themes/SupremacyClient
See also generic.xaml in SupremacyClientComponents/Themes/InfoCard Theme.xaml Default.xaml Icons.xaml ClientApp.xaml.cs SystemScreen.xaml

1/17/16: Found that Mikes code in ClientApp.xaml.cs will already select for Major race. Need new folders for each major race in SupremacyClient/themes/(major race), edit paths to Resources in the .xaml files found in each races set of .xaml files. File names in SupremacyClient/themes/(major race) are not unique but content in Resources is. Now you can edit files in Resources for unique UI.

2/13/16:

<Polygon
Points="300,200 400,125 400,275 300,200"
Stroke="Purple"
StrokeThickness="2">
<Polygon.Fill>
<SolidColorBrush Color="Blue" Opacity="0.4"/>
</Polygon.Fill>
</Polygon>

Makes a left pointing triangle, purple outline and blue body

=== 2015 ===

*'''Animation.cs''' (animation of opening screen): This is where we can set the number of images, frames, and the rate they play at, currently all images in 30 seconds. We may want that to run faster. The images you will make for the ship de-cloaking will be located in Resources / Images / Animation.
* \supremacyclient\'''ClientModule.cs''':
**Found a place to add the right mouse click instructions for the Panel Access Menu. A thing called the statusWindow held the text "loading" while you wait for a game to load. Added the information there for new players

*FMOD is partly replace by AudioEngine.cs and others - just find it out

=== 2014 ===

== some code ==

for Theme and UI see >> '''[[Theme]]'''

=== miscellaneous ===

*Mainline\SupremacyClient\GameContextMenu.cs

*\Mainline\SupremacyUI\SystemProductionPanel.cs

*\Mainline\SupremacyCore\Orbitals\FleetOrders.cs -> all items inside a sector

*Mainline\SupremacyClient\GameContextMenu.cs (Access Popup Menu - or use F1 to F5)

*\Mainline\SupremacyClientComponents\Controls\InfoCard\InfoCard.cs (-> Tooltips ??)
**\Mainline\SupremacyClient\themes\Federation\InfoCard.xaml -> <Setter Property="Width" Value="500" /> (BEFORE: 250)

*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyPlanetaryBuildQueueView.xaml - Colonies Screen Content

*\Mainline\SupremacyCore\Universe\Colony.cs
*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyStructureListView.xaml
**Size of this area: 720 x 240

*\Mainline\SupremacyClient\Views\GalaxyScreen\TaskForceListView.xaml

=== Version Number ===

Look for version number control in AssemblyInfo.cs

your hard disk code folder BotF2\SupremacyClient\Properties\AssemblyInfo.cs

---
example code: (put in your current star date)

*[assembly: AssemblyVersion("2018.11.20.0")]
*[assembly: AssemblyFileVersion("2018.11.20.0")]

=== Ships ===

*\Fleets.cs
*\FleetOrder.cs (without a "s" - beware of it)
*\FleetOrders.cs

*\mainline\supremacyclientcomponents\views\galaxyscreen\galaxyscreenpresenter.cs TaskForcesList

==== Building Ships ====

*Cancelling -> Breakpoint at Line 185 at OnShipyardBuildProjectsChanged() \Mainline\SupremacyClientComponents\Views\ColonyScreen\ColonyScreenPresentationModel.cs

=== Sounds ===

*\Mainline\SupremacyClient\AudioEngine.cs (for Music), for Sounds >> SoundPlayerAction is used (search for \Resources\UI\Federation\SoundsButtonClick.wav)
*and in \Mainline\SupremacyClientComponents\Views\SystemAssaultScreen\SystemAssaultScreenViewModel.cs -> Uri is used (e.g. CombatLaser.wav)

=== Galaxy Generator ===

*\Mainline\SupremacyCore\Universe\GalaxyGenerator.cs

=== Values ===
*CivID: 0 = Federation...

=== TurnPhase ===

WaitOnPlayers = 0,
PreTurnOperations,
ResetObjects,
FleetMovement,
Combat,
PopulationGrowth,
PersonnelTraining,
Research,
Scrapping,
Maintenance,
ShipProduction,
Production,
Trade,
Morale,
MapUpdates,
PostTurnOperations,
SendUpdates,
Diplomacy,
WaitOnAIPlayers

=== older list ===

{|class="wikitable sortable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |where
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Folder
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |File
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Function
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Date
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Description
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameContext.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
initialising game
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|
Raw Materials, Deuterium, Dilithium is collected cross over all colonies and used by all colonies
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoShipProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|

|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Combat
|style=text-align:center|InvasionArena.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
SystemAssault
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Orbital
|style=text-align:center|Shipyard.cs
|style=text-align:center|GetBuildOutput(int slot)
|style=text-align:center| [https://bitbucket.org/Bloodwurm/BotF2dev/commits/1aafc8f6e47e9e3b9c20de79f2d02f197c023d63 2014-01-15]
|style=text-align:left|
just selects output (active?) and bonus (BonusType.PercentShipBuilding), since 2014-01-15 also case PopulationRatio or IndustryRatio
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|GetProductionOutput(ProductionCategory category)
|style=text-align:center|
|style=text-align:left|
see last line, too !
*Food: minimum 10
*Research:
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*Industry: '''minimum 10 !'''
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*last line: return ((int)(baseOutput + (baseOutput * modifier.Efficiency)) + modifier.Bonus);
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasFoodBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasFoodBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasEnergyBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasEnergyBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-ClientComp
|style=text-align:center|Views\GalaxyScreen
|style=text-align:center|GalaxyScreenView.cs
|style=text-align:center|GalaxyScreenView()
|style=text-align:center|
|style=text-align:left|GalaxyView Hotkeys Definition (see [[Hotkey]]s)
|style=text-align:left|
|style=text-align:left|

|}

== Botf2-coding-practice ==

*http://star-trek-supremacy.proboards.com/thread/349/botf2-coding-practice (intern)

*prepare:
**...we are using SourceTree, provided by bitbucket (another option: TortoiseHg with Mercurial - to access the supremacy code repository http://tortoisehg.bitbucket.org/)
**PuTTYgen - to generate a ssh key to allow using ssh protocol instead of slow https http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
***or use C:\Program Files (x86)\Atlassian\SourceTree\tools\putty..puttygen.exe....generate a key (using a phrase is not neccessary)
***copy the public key (4-5 lines) into your bitbucket account/profile under SSH Keys, label it with any title and CopyPaste
**we are using Visual Studio Community 2013 Update 4 (select the Community Version) https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
**we are not(!) using Visual Studio Community 2015 RC - to compile the code (ISO is recommend)....still need to check if Supremacy code compiles with it, so instead we might need to depend on VS2013 http://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs....for VS 2015 we read to create a new project, import Supremacy and go through all the issues
**you also need to have an account on http://bitbucket.org
**and you should have Skype installed to participate in the meetings we have

*when you attempt to clone by ssh instead of https, check the following tutorial: http://confluence.atlassian.com/display/BITBUCKET/Set+up+SSH+for+Mercurial

*here some simple text editors useful to edit stuff like xml files, just pick the one you prefer they all are great:
**http://www.sublimetext.com/
**http://www.contexteditor.org/index.php
**http://notepad-plus-plus.org/ (used by reg atm)

== SourceTree ==

*Download >> https://www.sourcetreeapp.com/?v=win (or while cloning...use the link below blue Clone Button)

*Tools: 3rd point: OPTIONS

*SSH Client Configuration:
**SSH Key: c:\....\ReginaldPutty.ppk
**SSH Client: (IMPORTANT) PuTTY/Link (not SSH !!)
**automatically start: yes

== Visual Studio ==

It's possible (and standard) to compile the game with Visual Studio. No further stuff of programs is needed, except matching Resources folder. Mention that the compiled exe is then in \Mainline\bin\Debug (or \Release).

=== Visual C++ Library ===

IMPORTANT: As Microsoft no longer provides Visual C++ Library as standard installed component ...don't forget to select or install this manually! In VS you can recognize it if \Supremacy Native is unload (sign is greyed out a little bit)

==== SupremacyNative ====

SupremacyNative is C++ coded. Sometimes there are some problems with it https://developercommunity.visualstudio.com/content/problem/312852/internal-compiler-error-in-vs158-msc1cpp-line-1518.html

=== VS2019 ===

* meanwhile we are on VS 2019 Community version https://www.visualstudio.com/downloads

=== VS2017 ===

In May 2017 we're trying to change to VS 2017 Community version https://www.visualstudio.com/downloads

*you might want to change language at TOOLS > OPTIONS > ENVIROMENT > INTERNATIONAL SETTINGS

* first make a clean !!, maybe for each single project (10 of 10)

* SOLUTION EXPLORER - right mouse click - retarget (in the middle) - select newest versions

* (this should be only needed once and should be uploaded to Repository by one guy) SupremacyClient > Set as start Project

*after cleaning maybe use REBUILD

for more see >> [[#Tools|here]]

=== VS2015 ===

since April 2016 we're using VS 2015

*Visual Studio '''Community''' 2015 RC - to compile the code (ISO is recommend) ... still need to check if Supremacy code compiles with it, so instead we might need VS2013. NEW: we try to go to VS 2015 now.
https://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs - you need the "Community" Version, currently (Apr 2016) version "Update 2"

==== VS 2015 Update 3 ====

*says it does uninstall Update 2
*needs update to 33 GB to install (only if every is selected) - seems to need some hours...

=== old VS ===

*Visual Studio Community 2013 (Community version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2012 (Express version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2008 (German) http://www.microsoft.com/de-de/download/details.aspx?id=13276

=== Tools ===

*Indent Guides https://visualstudiogallery.msdn.microsoft.com/e792686d-542b-474a-8c55-630980e72c30 Adds vertical lines at each indent level.

* Vertical tabs https://marketplace.visualstudio.com/items?itemName=VisualStudioProductTeam.ProductivityPowerPack2017

*PowerShell Tools für VS 2015

=== Tips ===
*TOOLS > OPTIONS > ENVIRONMENT > Color theme -> Black

*TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Detect when file is changed outside... -> Yes
**TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Reload modified files... -> Yes

*DEBUG > OPTIONS > PROJECTS... > BUILD AND RUN > when code=project is changed="out of date" > "Always Build" (checkbox "only build ...on Run" is marked)
**https://www.vb-paradise.de/index.php/Thread/47935-Code-bei-Klick-auf-Debugging-starten-kompilieren-wenn-er-sich-ge%C3%A4ndert-hat/

*TOOLS > OPTIONS > TEXT EDITOR > ALL LANGUAGES > Line Number (activate for all)

*DEBUG > SUPREMACY CLIENT PROPERTIES (last) > DEBUG > Start project > Command line arguments: "-aiexplore -SAVEDGAME:auto" (if you save in Supremacy manually a game with name "auto" (independent from game's "(autosave)", this manually saved game can be loaded at startup.
**"-aiexplore" isn't necessary. For more see [[Command line parameter]]
**if working for example on Cardassian UI just save Cardassian as "auto".
**when you want to change to Klingons, just retire and start Klingons. If you want to work steady on Klingons, save a Klingon's game with auto.
**if you want to start a new game steady, just go Command line arguments (see above) and change the filename to an unused one like "-SAVEDGAME:auto123"

*activate Toolbar BUILD by right mouse click on Toolbar line

* Tools -> Options -> Debugging -> Output Window -> Module Load Messages -> Off

==== Editor ====
we're using some different editors
*one option is to drag'n'drop files like xml to Visual Studio
*sometimes we use Notepad++ https://notepad-plus-plus.org/download with Extension Compare (PLUGINS > PLUGIN MANAGER > SHOW P-Manager > "Compare" ...install
*for a black style we use Sublime http://www.sublimetext.com/2

==== Screenshot ====

*reg likes Greenshot http://getgreenshot.org/
**puts an icon into task bar. There: > PREFERENCES
***PREFERENCES > GENERAL: reg uses for "Capture region" CRTL+PRNT (and no other hotkey)
***PREFERENCES > OUTPUT: define a folder at "Storage location" and a standard file type (default is *.png)
***PREFERENCES > DESTINATION: (reg's settings)
****- turn off "Select destination dymnamically"
****- open in image editor
****- copy to clipboard
**Usage:
***press Hotkey and make Screenshot
***paste immediately anywhere OR
***work on it inside Greenshot (give red circles or mark up in any colour), give numbers, obfuscate and more
***save or save as jpg or print

== Compiling ==

if you have an error with "Glyphs.xaml", than make sure you have copied \Resources MANUALLY into the output folders - this was changed in 2015. The output folder depends on compiling method "Debug" or "Release", it is
*for DEBUG _: (YourRepositoryFolder)\Mainline\bin\'''Debug\Resources''' or
*for RELEASE: (YourRepositoryFolder)\Mainline\bin\'''Release\Resources'''

it's creating:
*1> Supremacy.Scripting -> %path_repo%\bin\Debug\lib\Supremacy.Scripting.dll
*2> SupremacyCore -> %path_repo%\bin\Debug\lib\SupremacyCore.dll
*3> Supremacy.Xna -> %path_repo%\bin\Debug\lib\Supremacy.Xna.dll
*4> SupremacyClientComponents -> %path_repo%\bin\Debug\lib\SupremacyClientComponents.dll
*5> SupremacyWPF -> %path_repo%\bin\Debug\lib\SupremacyWPF.dll
*6> SupremacyService -> %path_repo%\bin\Debug\lib\SupremacyService.dll
*7> SupremacyUI -> %path_repo%\bin\Debug\lib\SupremacyUI.dll

== Visual C# ==

build in Visual Studio

<img>http://botf2.square7.ch/wiki-files/images/VS2015.jpg</img>

== SunBurn ==

SunBurn is on hold for now. Kenneth was working sometimes with SunBurn...this might be a site for this http://channel9.msdn.com/coding4fun/blog/No-need-for-sunscreen-you-want-this-SunBurn-SunBurn-v2-RTMs-including-the-free-SunBurn-Framework-Edi

*http://en.wikipedia.org/wiki/List_of_game_engines

== .Net ==

you should use latest [http://www.microsoft.com/net .Net-version] (2014: version 4.5.1)

== XNA ==

"Could not load file or assembly 'Microsoft.Xna.Framework.dll' or one of its dependencies. The specified module could not be found."

*suggestion by reg: go to \Resources\Models and rename the "Models"-folder to "Models-SetOffline" or something else (if building a ship no model is shown -as it is to most of the ships- but otherwise the game could work fine)

This suggests the problem is with your XNA installation. The game uses XNA to display the 3D ship models in the shipyard. There's no way to disable the models so XNA wouldn't be needed. So to be able to play the game, i'd advise to uninstall XNA, then install the latest version.

XNA 3.1 (this one you need in any case): http://www.microsoft.com/en-us/download/details.aspx?id=15163

XNA 4.0 Download link: http://www.microsoft.com/en-gb/download/details.aspx?id=20914

== Try ==

(for boolean)

try
{
return true;
}
catch (Exception e)
{
var errors = new System.Collections.Concurrent.ConcurrentStack<Exception>();
errors.Push(e);
return false;
}
finally
{
xxx;
}
;

== Contexts ==

*AppContext (programm running)
*GameContext.Current (Game started - so after StartScreen)
*PlayerContext.Current

== Text ==
=== en.txt ===
* XAML example: Text="{s:StringResource EMPIRES_HEADER}"
* string _text = String.Format(ResourceManager.GetString("KEY_IN-EN_TXT"),parameter1, parameter2;

== LocalPlayer ==

*AppContext.LocalPlayer (just inside XAML-code files ??)

== Civilization ==

just the data out of Civilization.xml ... for more see [[#CivilizationManager]]

== CivilizationManager ==

CivilizationManager holds all the data like amount of credits, diplomacy, sitreps and more

*GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

== GameLog ==

if not available, try "Quick actions" -> using Supremacy.Utility;

GameLog.Core.GameData.DebugFormat("Turn {0};xx=;{1};xx=;{2};xx={3};xx={4};xx={5};xx={6};xx={7};xx={8};xx={9};"
, GameContext.Current.TurnNumber
, xx
, xx
);

== MessageBox (Windows Style) ==

MessageBox.Show("Borg turned into Expanded", "WARNING", MessageBoxButton.OK);

== MessageDialog (Supremacy Style) ==

var result = MessageDialog.Show("Borg turned into Expanded", MessageDialogButtons.YesNo);

== SoundPlaying ==

* _soundPlayer.PlayFile("Resources/SoundFX/ChatMessage.wav");

UI

2020-10-18T12:21:12Z

Reginald: /* Theme */

== Intro ==

some words to UI....

* starting a game starts every of the five screens at the same time ! (Map/System/...)

* inside the screens it is mostly jumping to the last selected tab (e.g. System: Production or Shipbuilding)
** these complete screens are done by different parts:
***left top: Template like SystemInfo
***left bottom: Template like BuildQueue
***right: ProductionScreen
***right bottom: Planets...

== Theme ==

* Themes are appearance of each Empire's UI.

Common stuff is content of Global.xaml

Empire's themes are defined in Shared.xaml

=== Border ===

* LCARS_BorderStyle (e.g. Chat-Window)
* LCARS_ThinBorderStyle (e.g. Summary)

=== Button ===

* GameButton // e.g. Economy
* LCARS_BorderButtonStyle
* LCARS_BorderToggleButtonStyle" // e.g. CHAT Button in GalaxyMapView
* LCARS_SimpleButtonStyle // e.g. REDEPLOY-Button
* LCARS_SimpleToggleButtonStyle

* Default = IsEnable = Current Selection = GREEN = LCARS_Dom3Gradient_Bottom_Top
* MouseOver = PINK GRADIENT = LCARS_Dom2Gradient_Bottom_Top
* IsPressed = PINK = LCARS_Dom1Gradient_Bottom_Top
* IsChecked

=== TextBrush ===

* ControlTextForegroundBrushKey

* HeaderTextForegroundBrushKey

* DefaultTextForegroundBrushKey

* ImageBorderBrushKey

* DisabledTextForegroundBrushKey

* HighlightBrushKey

* InactiveHighlightBrushKey

* AlertTextForegroundBrushKey

* HighlightBrushKey

== Colour ==

=== LightBlue ===
* Research
* Dilithium

=== Red ===
* Deuterium

=== Silver ===
* Intelligence

=== Gray ===
* Duranium = Rax Materials

=== Goldrod ===
* Energy
* Total Population in EmpireInfo

=== Borg ===

*LCARS_GreenTextBrush

*DarkGreen

== ClientApp ==

* SupremacyClient\ClientApp.xaml.cs - this is the main app - starting at "EntryPoint"
* SupremacyClient\ClientWindow.xaml.cs - this is the main window

== MultiplayerSetupScreen ==

* MultiplayerSetupScreen.xaml + MultiplayerSetupScreen.xaml.cs

== SUMMARY ==

* SitRepEntry.cs

== Context Menu ==

* SupremacyClient\themes\Dominion\GameContextMenu.xaml
* GalaxyScreenView.xaml

== Bottom View ==

various parts are filled in

=== PlanetsViewRegion ===

* \SupremacyUI\StarSystemPanel.cs

=== AssignedShipListRegion ===

* AssignedShipListRegion

=== PART_ChatPanel ===

* PART_ChatPanel

== F1 ==

* GalaxyScreenView.xaml (Race specific)

* Expander EmpireInfo > EmpireInfoView.xaml

== F2 ==

=== Right ===

* SystemProductionPanel.cs (without any xaml file !)

=== Left ===

* ColonyHandlingListView.cs

== F3 ==

* NewDiplomacyScreen.xaml + NewDiplomacyScreen.xaml.cs
* DiplomacyScreenViewModel.cs
* \SupremacyCore\Diplomacy\DiplomacyHelper.cs
* DiplomatAI.cs
* ForeignPowerViewModel.cs

* DiplomacyMessageViewModel.cs and more

* AcceptProposalVisitor.cs
* RejectProposalVisitor.cs

== F4 ==

== F5 ==

* AssetsScreen.xaml + AssetsScreen.xaml.cs
** TAB: Colonies -> a) Headline directly in AssetsScreen.xaml
** TAB: Colonies -> b) ColonyList ="{Binding Path=Colonies} -> SystemListItem.xaml (+.cs)
*
** TAB: SpyReport -> b)

* AssetsScreenPresentationModel.cs

* ActiveAgreementViewModel.cs

== F11 ==

* File:CheatMenu.xaml + File:CheatMenu.xaml.cs

== CTRL+F11 ==

* FakeDialog.xaml + FakeDialog.xaml.cs

== ClientSettings ==

* ClientSettings.cs - stuff is written into file > ClientSettings.xaml

=== CTRL+O ===

* ClientOptionsDialog.xaml + ClientOptionsDialog.xaml.cs

==== File:ClientOptionsDialog.xaml ====

* File:ClientOptionsDialog.xaml

=== CTRL+Z ===

* ClientTracesDialog.xaml + ClientTracesDialog.xaml.cs

==== File:TracesOptionsPage.xaml ====

* File:TracesOptionsPage.xaml + File:TracesOptionsPage.xaml.cs

== GameOptionsPanel ==

at Starting

* GameOptionsPanel.xaml + GameOptionsPanel.xaml.cs

== LoadGameDialog ==

* LoadGameDialog.xaml.cs

* SavedGameHeader.cs ( Header checks the save game version if the file is compatible)

== Files ==

* ClientSettings.xaml

== Important Code Files ==

* ClientModule.cs ... starts the App and 'ends' at StartScreen..

* ClientOptions ... like Music Volume

* GameEngine.cs ... start for example a SinglePlayerGame or MultiPlayerGame
** Do....

* GameOptions like GalaxySize

* SupremacyCore\Game\CivilizationManager.cs ... handling Empires and other Civilizations

=== Sector ===
** contains a System, Nebulas are also a System
** a system might contain a Colony (which is a inhabitanted system)
** a colony might have Planets (and them moons)

* Colony.cs ... doing stuff for a single Colony

=== Civilization ===

* CivilizationManager.cs > contains the civilizations (current credits and more)
* Civilization.cs > only stuff from Civilization.xaml like Name

=== SAVELOAD ===

* SavedGameHeader.cs = Header (Name of saved file, version nummer (!!) and more)
* SavedGameManager.cs = saving Game

UI

2020-10-18T09:53:35Z

Reginald: /* F2 */

== Intro ==

some words to UI....

* starting a game starts every of the five screens at the same time ! (Map/System/...)

* inside the screens it is mostly jumping to the last selected tab (e.g. System: Production or Shipbuilding)
** these complete screens are done by different parts:
***left top: Template like SystemInfo
***left bottom: Template like BuildQueue
***right: ProductionScreen
***right bottom: Planets...

== Theme ==

* Themes are appearance of each Empire's UI.

Common stuff is content of Global.xaml

Empire's themes are defined in Shared.xaml

=== Border ===

* LCARS_BorderStyle (e.g. Chat-Window)
* LCARS_ThinBorderStyle (e.g. Summary)

== Colour ==

=== LightBlue ===
* Research
* Dilithium

=== Red ===
* Deuterium

=== Silver ===
* Intelligence

=== Gray ===
* Duranium = Rax Materials

=== Goldrod ===
* Energy
* Total Population in EmpireInfo

=== Borg ===

*LCARS_GreenTextBrush

*DarkGreen

== ClientApp ==

* SupremacyClient\ClientApp.xaml.cs - this is the main app - starting at "EntryPoint"
* SupremacyClient\ClientWindow.xaml.cs - this is the main window

== MultiplayerSetupScreen ==

* MultiplayerSetupScreen.xaml + MultiplayerSetupScreen.xaml.cs

== SUMMARY ==

* SitRepEntry.cs

== Context Menu ==

* SupremacyClient\themes\Dominion\GameContextMenu.xaml
* GalaxyScreenView.xaml

== Bottom View ==

various parts are filled in

=== PlanetsViewRegion ===

* \SupremacyUI\StarSystemPanel.cs

=== AssignedShipListRegion ===

* AssignedShipListRegion

=== PART_ChatPanel ===

* PART_ChatPanel

== F1 ==

* GalaxyScreenView.xaml (Race specific)

* Expander EmpireInfo > EmpireInfoView.xaml

== F2 ==

=== Right ===

* SystemProductionPanel.cs (without any xaml file !)

=== Left ===

* ColonyHandlingListView.cs

== F3 ==

* NewDiplomacyScreen.xaml + NewDiplomacyScreen.xaml.cs
* DiplomacyScreenViewModel.cs
* \SupremacyCore\Diplomacy\DiplomacyHelper.cs
* DiplomatAI.cs
* ForeignPowerViewModel.cs

* DiplomacyMessageViewModel.cs and more

* AcceptProposalVisitor.cs
* RejectProposalVisitor.cs

== F4 ==

== F5 ==

* AssetsScreen.xaml + AssetsScreen.xaml.cs
** TAB: Colonies -> a) Headline directly in AssetsScreen.xaml
** TAB: Colonies -> b) ColonyList ="{Binding Path=Colonies} -> SystemListItem.xaml (+.cs)
*
** TAB: SpyReport -> b)

* AssetsScreenPresentationModel.cs

* ActiveAgreementViewModel.cs

== F11 ==

* File:CheatMenu.xaml + File:CheatMenu.xaml.cs

== CTRL+F11 ==

* FakeDialog.xaml + FakeDialog.xaml.cs

== ClientSettings ==

* ClientSettings.cs - stuff is written into file > ClientSettings.xaml

=== CTRL+O ===

* ClientOptionsDialog.xaml + ClientOptionsDialog.xaml.cs

==== File:ClientOptionsDialog.xaml ====

* File:ClientOptionsDialog.xaml

=== CTRL+Z ===

* ClientTracesDialog.xaml + ClientTracesDialog.xaml.cs

==== File:TracesOptionsPage.xaml ====

* File:TracesOptionsPage.xaml + File:TracesOptionsPage.xaml.cs

== GameOptionsPanel ==

at Starting

* GameOptionsPanel.xaml + GameOptionsPanel.xaml.cs

== LoadGameDialog ==

* LoadGameDialog.xaml.cs

* SavedGameHeader.cs ( Header checks the save game version if the file is compatible)

== Files ==

* ClientSettings.xaml

== Important Code Files ==

* ClientModule.cs ... starts the App and 'ends' at StartScreen..

* ClientOptions ... like Music Volume

* GameEngine.cs ... start for example a SinglePlayerGame or MultiPlayerGame
** Do....

* GameOptions like GalaxySize

* SupremacyCore\Game\CivilizationManager.cs ... handling Empires and other Civilizations

=== Sector ===
** contains a System, Nebulas are also a System
** a system might contain a Colony (which is a inhabitanted system)
** a colony might have Planets (and them moons)

* Colony.cs ... doing stuff for a single Colony

=== Civilization ===

* CivilizationManager.cs > contains the civilizations (current credits and more)
* Civilization.cs > only stuff from Civilization.xaml like Name

=== SAVELOAD ===

* SavedGameHeader.cs = Header (Name of saved file, version nummer (!!) and more)
* SavedGameManager.cs = saving Game

UI

2020-10-18T09:19:52Z

Reginald: /* F2 */

UI

2020-10-11T10:46:26Z

Reginald: /* Bottom View */

UI

2020-10-04T13:57:26Z

Reginald: /* Theme */

UI

2020-10-04T13:49:17Z

Reginald: /* Colour */

UI

2020-10-04T13:47:29Z

Reginald:

UI

2020-10-04T13:46:48Z

Reginald: /* Borg */

UI

2020-10-04T13:00:27Z

Reginald:

UI

2020-10-04T11:39:24Z

Reginald: /* F1 */

UI

2020-10-04T09:57:23Z

Reginald: /* F1 */

Source Code

2020-10-03T11:59:35Z

Reginald: /* en.txt */

== Source Code ==

http://guganeshan.com/blog/setting-up-git-and-tortoisegit-with-bitbucket-step-by-step.html

=== official ===

* code is now at https://github.com/BotF2/BotF2.git

*last source code https://bitbucket.org/mstrobel/supremacy/overview (it's in C#, also named CSharp. [[#Visual Studio]] is used for coding.)
**Mike's Post: build in [http://www.microsoft.com/downloads/dlx/en-us/ThankYou.aspx?FamilyID=75568AA6-8107-475D-948A-EF22627E57A5 VS2010] with .NET 4.0. You may need the [http://en.csharp-online.net/Download_Free_Microsoft_Visual_CSharp_.NET#Download_Microsoft_Visual_Studio_Async_Community_Technology_Preview_.28CTP.29 C# Async CTP]. http://bote2.square7.ch/forum/viewtopic.php?p=70790#p70790
**http://bote2.square7.ch/forum/viewtopic.php?p=70781#p70781
*** Supremacy.Game.GameEngine is where you'll find most of the game logic. That's where most of the turn processing happens.
*** The SupremacyCore project is where you'll find the foundation of the game.
*** SupremacyService is just the game server (all the important bits it interacts with are in SupremacyCore).
*** SupremacyClientComponents is UI infrastructure.
*** SupremacyUI and SupremacyWPF are older UI infrastructure stuff, much of which has been phased out and replaced by newer and better stuff in SupremacyClientComponents. The most interesting stuff in SupremacyUI is GalaxyGridPanel, which draws the galactic map. It also has the spinning planet views.
*** Supremacy.Xna is where the XNA/3D stuff is located--it's not used heavily yet, but it has some effects for the invasion screen, a newer star renderer, a 3D spinning ship renderer, etc.
*** Supremacy.Scripting is an expression language parser/compiler.
*** SupremacyClient is the main graphical client and has most of the game screen implementations.

*old source code can be taken from here: http://supremacy.codeplex.com/ (last upload from MStrobel at 03.01.2011)

==== ClientContext vs AppContext ====

taken from https://bitbucket.org/kflanagan/supremacydev/commits/0d562ce676425cd5da19cfdbcf1b6c18c7d0d135

*IClientContext is used by SupremacyCore to interface clients participating on a game, both local and over network. The IClientContext further includes an interface to IGameContext which gives access to the game data itself inside the '''SupremacyClient app'''
*However there should be an option to also include local properties not known to the Core, which is why this is done alternatively another context would have to be introduced for local data, but then still all the client code would have to be updated to make use of it

==== .XAML files ====

In Windows Presentation Foundation (WPF), a windows app framework used by Supremacy, XAML forms a user interface markup language to define UI elements, data binding, events, and other features.

Info resources:

*MS Article: [https://msdn.microsoft.com/en-us/library/ms745683(v=vs.110).aspx XAML Styling and Templating]

*Youtube video: [https://www.youtube.com/watch?v=0qE5hyuU9hE Introduction to XAML] (26min)

== Bitbucket ==

*https://confluence.atlassian.com/display/BITBUCKET/Maintaining+a+Mercurial+Repository

== Changes ==

see [[ChangeLog|here]] or https://bitbucket.org/mstrobel/supremacy/commits/branch/default

=== 2016 ===

==== XAML ====

*January 2016 [Planned]: Hope to get Major Race specific UI build through use of generic XAML files.
* ClientApp.xaml.cs has the code to direct UI to race specific folders of xaml files in SupremacyClient/themes/{0}

Looking at SystemScreen.xaml, Global.xaml and ClientModules.cs in Themes/SupremacyClient
See also generic.xaml in SupremacyClientComponents/Themes/InfoCard Theme.xaml Default.xaml Icons.xaml ClientApp.xaml.cs SystemScreen.xaml

1/17/16: Found that Mikes code in ClientApp.xaml.cs will already select for Major race. Need new folders for each major race in SupremacyClient/themes/(major race), edit paths to Resources in the .xaml files found in each races set of .xaml files. File names in SupremacyClient/themes/(major race) are not unique but content in Resources is. Now you can edit files in Resources for unique UI.

2/13/16:

<Polygon
Points="300,200 400,125 400,275 300,200"
Stroke="Purple"
StrokeThickness="2">
<Polygon.Fill>
<SolidColorBrush Color="Blue" Opacity="0.4"/>
</Polygon.Fill>
</Polygon>

Makes a left pointing triangle, purple outline and blue body

=== 2015 ===

*'''Animation.cs''' (animation of opening screen): This is where we can set the number of images, frames, and the rate they play at, currently all images in 30 seconds. We may want that to run faster. The images you will make for the ship de-cloaking will be located in Resources / Images / Animation.
* \supremacyclient\'''ClientModule.cs''':
**Found a place to add the right mouse click instructions for the Panel Access Menu. A thing called the statusWindow held the text "loading" while you wait for a game to load. Added the information there for new players

*FMOD is partly replace by AudioEngine.cs and others - just find it out

=== 2014 ===

== some code ==

for Theme and UI see >> '''[[Theme]]'''

=== miscellaneous ===

*Mainline\SupremacyClient\GameContextMenu.cs

*\Mainline\SupremacyUI\SystemProductionPanel.cs

*\Mainline\SupremacyCore\Orbitals\FleetOrders.cs -> all items inside a sector

*Mainline\SupremacyClient\GameContextMenu.cs (Access Popup Menu - or use F1 to F5)

*\Mainline\SupremacyClientComponents\Controls\InfoCard\InfoCard.cs (-> Tooltips ??)
**\Mainline\SupremacyClient\themes\Federation\InfoCard.xaml -> <Setter Property="Width" Value="500" /> (BEFORE: 250)

*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyPlanetaryBuildQueueView.xaml - Colonies Screen Content

*\Mainline\SupremacyCore\Universe\Colony.cs
*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyStructureListView.xaml
**Size of this area: 720 x 240

*\Mainline\SupremacyClient\Views\GalaxyScreen\TaskForceListView.xaml

=== Version Number ===

Look for version number control in AssemblyInfo.cs

your hard disk code folder BotF2\SupremacyClient\Properties\AssemblyInfo.cs

---
example code: (put in your current star date)

*[assembly: AssemblyVersion("2018.11.20.0")]
*[assembly: AssemblyFileVersion("2018.11.20.0")]

=== Ships ===

*\Fleets.cs
*\FleetOrder.cs (without a "s" - beware of it)
*\FleetOrders.cs

*\mainline\supremacyclientcomponents\views\galaxyscreen\galaxyscreenpresenter.cs TaskForcesList

==== Building Ships ====

*Cancelling -> Breakpoint at Line 185 at OnShipyardBuildProjectsChanged() \Mainline\SupremacyClientComponents\Views\ColonyScreen\ColonyScreenPresentationModel.cs

=== Sounds ===

*\Mainline\SupremacyClient\AudioEngine.cs (for Music), for Sounds >> SoundPlayerAction is used (search for \Resources\UI\Federation\SoundsButtonClick.wav)
*and in \Mainline\SupremacyClientComponents\Views\SystemAssaultScreen\SystemAssaultScreenViewModel.cs -> Uri is used (e.g. CombatLaser.wav)

=== Galaxy Generator ===

*\Mainline\SupremacyCore\Universe\GalaxyGenerator.cs

=== Values ===
*CivID: 0 = Federation...

=== TurnPhase ===

WaitOnPlayers = 0,
PreTurnOperations,
ResetObjects,
FleetMovement,
Combat,
PopulationGrowth,
PersonnelTraining,
Research,
Scrapping,
Maintenance,
ShipProduction,
Production,
Trade,
Morale,
MapUpdates,
PostTurnOperations,
SendUpdates,
Diplomacy,
WaitOnAIPlayers

=== older list ===

{|class="wikitable sortable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |where
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Folder
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |File
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Function
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Date
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Description
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameContext.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
initialising game
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|
Raw Materials, Deuterium, Dilithium is collected cross over all colonies and used by all colonies
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoShipProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|

|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Combat
|style=text-align:center|InvasionArena.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
SystemAssault
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Orbital
|style=text-align:center|Shipyard.cs
|style=text-align:center|GetBuildOutput(int slot)
|style=text-align:center| [https://bitbucket.org/Bloodwurm/BotF2dev/commits/1aafc8f6e47e9e3b9c20de79f2d02f197c023d63 2014-01-15]
|style=text-align:left|
just selects output (active?) and bonus (BonusType.PercentShipBuilding), since 2014-01-15 also case PopulationRatio or IndustryRatio
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|GetProductionOutput(ProductionCategory category)
|style=text-align:center|
|style=text-align:left|
see last line, too !
*Food: minimum 10
*Research:
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*Industry: '''minimum 10 !'''
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*last line: return ((int)(baseOutput + (baseOutput * modifier.Efficiency)) + modifier.Bonus);
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasFoodBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasFoodBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasEnergyBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasEnergyBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-ClientComp
|style=text-align:center|Views\GalaxyScreen
|style=text-align:center|GalaxyScreenView.cs
|style=text-align:center|GalaxyScreenView()
|style=text-align:center|
|style=text-align:left|GalaxyView Hotkeys Definition (see [[Hotkey]]s)
|style=text-align:left|
|style=text-align:left|

|}

== Botf2-coding-practice ==

*http://star-trek-supremacy.proboards.com/thread/349/botf2-coding-practice (intern)

*prepare:
**...we are using SourceTree, provided by bitbucket (another option: TortoiseHg with Mercurial - to access the supremacy code repository http://tortoisehg.bitbucket.org/)
**PuTTYgen - to generate a ssh key to allow using ssh protocol instead of slow https http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
***or use C:\Program Files (x86)\Atlassian\SourceTree\tools\putty..puttygen.exe....generate a key (using a phrase is not neccessary)
***copy the public key (4-5 lines) into your bitbucket account/profile under SSH Keys, label it with any title and CopyPaste
**we are using Visual Studio Community 2013 Update 4 (select the Community Version) https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
**we are not(!) using Visual Studio Community 2015 RC - to compile the code (ISO is recommend)....still need to check if Supremacy code compiles with it, so instead we might need to depend on VS2013 http://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs....for VS 2015 we read to create a new project, import Supremacy and go through all the issues
**you also need to have an account on http://bitbucket.org
**and you should have Skype installed to participate in the meetings we have

*when you attempt to clone by ssh instead of https, check the following tutorial: http://confluence.atlassian.com/display/BITBUCKET/Set+up+SSH+for+Mercurial

*here some simple text editors useful to edit stuff like xml files, just pick the one you prefer they all are great:
**http://www.sublimetext.com/
**http://www.contexteditor.org/index.php
**http://notepad-plus-plus.org/ (used by reg atm)

== SourceTree ==

*Download >> https://www.sourcetreeapp.com/?v=win (or while cloning...use the link below blue Clone Button)

*Tools: 3rd point: OPTIONS

*SSH Client Configuration:
**SSH Key: c:\....\ReginaldPutty.ppk
**SSH Client: (IMPORTANT) PuTTY/Link (not SSH !!)
**automatically start: yes

== Visual Studio ==

It's possible (and standard) to compile the game with Visual Studio. No further stuff of programs is needed, except matching Resources folder. Mention that the compiled exe is then in \Mainline\bin\Debug (or \Release).

=== Visual C++ Library ===

IMPORTANT: As Microsoft no longer provides Visual C++ Library as standard installed component ...don't forget to select or install this manually! In VS you can recognize it if \Supremacy Native is unload (sign is greyed out a little bit)

==== SupremacyNative ====

SupremacyNative is C++ coded. Sometimes there are some problems with it https://developercommunity.visualstudio.com/content/problem/312852/internal-compiler-error-in-vs158-msc1cpp-line-1518.html

=== VS2019 ===

* meanwhile we are on VS 2019 Community version https://www.visualstudio.com/downloads

=== VS2017 ===

In May 2017 we're trying to change to VS 2017 Community version https://www.visualstudio.com/downloads

*you might want to change language at TOOLS > OPTIONS > ENVIROMENT > INTERNATIONAL SETTINGS

* first make a clean !!, maybe for each single project (10 of 10)

* SOLUTION EXPLORER - right mouse click - retarget (in the middle) - select newest versions

* (this should be only needed once and should be uploaded to Repository by one guy) SupremacyClient > Set as start Project

*after cleaning maybe use REBUILD

for more see >> [[#Tools|here]]

=== VS2015 ===

since April 2016 we're using VS 2015

*Visual Studio '''Community''' 2015 RC - to compile the code (ISO is recommend) ... still need to check if Supremacy code compiles with it, so instead we might need VS2013. NEW: we try to go to VS 2015 now.
https://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs - you need the "Community" Version, currently (Apr 2016) version "Update 2"

==== VS 2015 Update 3 ====

*says it does uninstall Update 2
*needs update to 33 GB to install (only if every is selected) - seems to need some hours...

=== old VS ===

*Visual Studio Community 2013 (Community version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2012 (Express version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2008 (German) http://www.microsoft.com/de-de/download/details.aspx?id=13276

=== Tools ===

*Indent Guides https://visualstudiogallery.msdn.microsoft.com/e792686d-542b-474a-8c55-630980e72c30 Adds vertical lines at each indent level.

* Vertical tabs https://marketplace.visualstudio.com/items?itemName=VisualStudioProductTeam.ProductivityPowerPack2017

*PowerShell Tools für VS 2015

=== Tips ===
*TOOLS > OPTIONS > ENVIRONMENT > Color theme -> Black

*TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Detect when file is changed outside... -> Yes
**TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Reload modified files... -> Yes

*DEBUG > OPTIONS > PROJECTS... > BUILD AND RUN > when code=project is changed="out of date" > "Always Build" (checkbox "only build ...on Run" is marked)
**https://www.vb-paradise.de/index.php/Thread/47935-Code-bei-Klick-auf-Debugging-starten-kompilieren-wenn-er-sich-ge%C3%A4ndert-hat/

*TOOLS > OPTIONS > TEXT EDITOR > ALL LANGUAGES > Line Number (activate for all)

*DEBUG > SUPREMACY CLIENT PROPERTIES (last) > DEBUG > Start project > Command line arguments: "-aiexplore -SAVEDGAME:auto" (if you save in Supremacy manually a game with name "auto" (independent from game's "(autosave)", this manually saved game can be loaded at startup.
**"-aiexplore" isn't necessary. For more see [[Command line parameter]]
**if working for example on Cardassian UI just save Cardassian as "auto".
**when you want to change to Klingons, just retire and start Klingons. If you want to work steady on Klingons, save a Klingon's game with auto.
**if you want to start a new game steady, just go Command line arguments (see above) and change the filename to an unused one like "-SAVEDGAME:auto123"

*activate Toolbar BUILD by right mouse click on Toolbar line

* Tools -> Options -> Debugging -> Output Window -> Module Load Messages -> Off

==== Editor ====
we're using some different editors
*one option is to drag'n'drop files like xml to Visual Studio
*sometimes we use Notepad++ https://notepad-plus-plus.org/download with Extension Compare (PLUGINS > PLUGIN MANAGER > SHOW P-Manager > "Compare" ...install
*for a black style we use Sublime http://www.sublimetext.com/2

==== Screenshot ====

*reg likes Greenshot http://getgreenshot.org/
**puts an icon into task bar. There: > PREFERENCES
***PREFERENCES > GENERAL: reg uses for "Capture region" CRTL+PRNT (and no other hotkey)
***PREFERENCES > OUTPUT: define a folder at "Storage location" and a standard file type (default is *.png)
***PREFERENCES > DESTINATION: (reg's settings)
****- turn off "Select destination dymnamically"
****- open in image editor
****- copy to clipboard
**Usage:
***press Hotkey and make Screenshot
***paste immediately anywhere OR
***work on it inside Greenshot (give red circles or mark up in any colour), give numbers, obfuscate and more
***save or save as jpg or print

== Compiling ==

if you have an error with "Glyphs.xaml", than make sure you have copied \Resources MANUALLY into the output folders - this was changed in 2015. The output folder depends on compiling method "Debug" or "Release", it is
*for DEBUG _: (YourRepositoryFolder)\Mainline\bin\'''Debug\Resources''' or
*for RELEASE: (YourRepositoryFolder)\Mainline\bin\'''Release\Resources'''

it's creating:
*1> Supremacy.Scripting -> %path_repo%\bin\Debug\lib\Supremacy.Scripting.dll
*2> SupremacyCore -> %path_repo%\bin\Debug\lib\SupremacyCore.dll
*3> Supremacy.Xna -> %path_repo%\bin\Debug\lib\Supremacy.Xna.dll
*4> SupremacyClientComponents -> %path_repo%\bin\Debug\lib\SupremacyClientComponents.dll
*5> SupremacyWPF -> %path_repo%\bin\Debug\lib\SupremacyWPF.dll
*6> SupremacyService -> %path_repo%\bin\Debug\lib\SupremacyService.dll
*7> SupremacyUI -> %path_repo%\bin\Debug\lib\SupremacyUI.dll

== Visual C# ==

build in Visual Studio

<img>http://botf2.square7.ch/wiki-files/images/VS2015.jpg</img>

== SunBurn ==

SunBurn is on hold for now. Kenneth was working sometimes with SunBurn...this might be a site for this http://channel9.msdn.com/coding4fun/blog/No-need-for-sunscreen-you-want-this-SunBurn-SunBurn-v2-RTMs-including-the-free-SunBurn-Framework-Edi

*http://en.wikipedia.org/wiki/List_of_game_engines

== .Net ==

you should use latest [http://www.microsoft.com/net .Net-version] (2014: version 4.5.1)

== XNA ==

"Could not load file or assembly 'Microsoft.Xna.Framework.dll' or one of its dependencies. The specified module could not be found."

*suggestion by reg: go to \Resources\Models and rename the "Models"-folder to "Models-SetOffline" or something else (if building a ship no model is shown -as it is to most of the ships- but otherwise the game could work fine)

This suggests the problem is with your XNA installation. The game uses XNA to display the 3D ship models in the shipyard. There's no way to disable the models so XNA wouldn't be needed. So to be able to play the game, i'd advise to uninstall XNA, then install the latest version.

XNA 3.1 (this one you need in any case): http://www.microsoft.com/en-us/download/details.aspx?id=15163

XNA 4.0 Download link: http://www.microsoft.com/en-gb/download/details.aspx?id=20914

== Try ==

(for boolean)

try
{
return true;
}
catch (Exception e)
{
var errors = new System.Collections.Concurrent.ConcurrentStack<Exception>();
errors.Push(e);
return false;
}
finally
{
xxx;
}
;

== Contexts ==

*AppContext (programm running)
*GameContext.Current (Game started - so after StartScreen)
*PlayerContext.Current

== Text ==
=== en.txt ===
* XAML example: Text="{s:StringResource EMPIRES_HEADER}"
* string _text = String.Format(ResourceManager.GetString("KEY_IN-EN_TXT"),parameter1, parameter2;

== LocalPlayer ==

*AppContext.LocalPlayer (just inside XAML-code files ??)

== Civilization ==

just the data out of Civilization.xml ... for more see [[#CivilizationManager]]

== CivilizationManager ==

CivilizationManager holds all the data like amount of credits, diplomacy, sitreps and more

*GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

== GameLog ==

GameLog.Client.GameData.DebugFormat("Civilization.cs: isBorgPlayable={0}, _throwOutRace={1}, _civType before: {2}", isBorgPlayable, _throwOutRace, _civType);

== MessageBox (Windows Style) ==

MessageBox.Show("Borg turned into Expanded", "WARNING", MessageBoxButton.OK);

== MessageDialog (Supremacy Style) ==

var result = MessageDialog.Show("Borg turned into Expanded", MessageDialogButtons.YesNo);

== SoundPlaying ==

* _soundPlayer.PlayFile("Resources/SoundFX/ChatMessage.wav");

Source Code

2020-10-03T11:59:22Z

Reginald: /* en.txt */

== Source Code ==

http://guganeshan.com/blog/setting-up-git-and-tortoisegit-with-bitbucket-step-by-step.html

=== official ===

* code is now at https://github.com/BotF2/BotF2.git

*last source code https://bitbucket.org/mstrobel/supremacy/overview (it's in C#, also named CSharp. [[#Visual Studio]] is used for coding.)
**Mike's Post: build in [http://www.microsoft.com/downloads/dlx/en-us/ThankYou.aspx?FamilyID=75568AA6-8107-475D-948A-EF22627E57A5 VS2010] with .NET 4.0. You may need the [http://en.csharp-online.net/Download_Free_Microsoft_Visual_CSharp_.NET#Download_Microsoft_Visual_Studio_Async_Community_Technology_Preview_.28CTP.29 C# Async CTP]. http://bote2.square7.ch/forum/viewtopic.php?p=70790#p70790
**http://bote2.square7.ch/forum/viewtopic.php?p=70781#p70781
*** Supremacy.Game.GameEngine is where you'll find most of the game logic. That's where most of the turn processing happens.
*** The SupremacyCore project is where you'll find the foundation of the game.
*** SupremacyService is just the game server (all the important bits it interacts with are in SupremacyCore).
*** SupremacyClientComponents is UI infrastructure.
*** SupremacyUI and SupremacyWPF are older UI infrastructure stuff, much of which has been phased out and replaced by newer and better stuff in SupremacyClientComponents. The most interesting stuff in SupremacyUI is GalaxyGridPanel, which draws the galactic map. It also has the spinning planet views.
*** Supremacy.Xna is where the XNA/3D stuff is located--it's not used heavily yet, but it has some effects for the invasion screen, a newer star renderer, a 3D spinning ship renderer, etc.
*** Supremacy.Scripting is an expression language parser/compiler.
*** SupremacyClient is the main graphical client and has most of the game screen implementations.

*old source code can be taken from here: http://supremacy.codeplex.com/ (last upload from MStrobel at 03.01.2011)

==== ClientContext vs AppContext ====

taken from https://bitbucket.org/kflanagan/supremacydev/commits/0d562ce676425cd5da19cfdbcf1b6c18c7d0d135

*IClientContext is used by SupremacyCore to interface clients participating on a game, both local and over network. The IClientContext further includes an interface to IGameContext which gives access to the game data itself inside the '''SupremacyClient app'''
*However there should be an option to also include local properties not known to the Core, which is why this is done alternatively another context would have to be introduced for local data, but then still all the client code would have to be updated to make use of it

==== .XAML files ====

In Windows Presentation Foundation (WPF), a windows app framework used by Supremacy, XAML forms a user interface markup language to define UI elements, data binding, events, and other features.

Info resources:

*MS Article: [https://msdn.microsoft.com/en-us/library/ms745683(v=vs.110).aspx XAML Styling and Templating]

*Youtube video: [https://www.youtube.com/watch?v=0qE5hyuU9hE Introduction to XAML] (26min)

== Bitbucket ==

*https://confluence.atlassian.com/display/BITBUCKET/Maintaining+a+Mercurial+Repository

== Changes ==

see [[ChangeLog|here]] or https://bitbucket.org/mstrobel/supremacy/commits/branch/default

=== 2016 ===

==== XAML ====

*January 2016 [Planned]: Hope to get Major Race specific UI build through use of generic XAML files.
* ClientApp.xaml.cs has the code to direct UI to race specific folders of xaml files in SupremacyClient/themes/{0}

Looking at SystemScreen.xaml, Global.xaml and ClientModules.cs in Themes/SupremacyClient
See also generic.xaml in SupremacyClientComponents/Themes/InfoCard Theme.xaml Default.xaml Icons.xaml ClientApp.xaml.cs SystemScreen.xaml

1/17/16: Found that Mikes code in ClientApp.xaml.cs will already select for Major race. Need new folders for each major race in SupremacyClient/themes/(major race), edit paths to Resources in the .xaml files found in each races set of .xaml files. File names in SupremacyClient/themes/(major race) are not unique but content in Resources is. Now you can edit files in Resources for unique UI.

2/13/16:

<Polygon
Points="300,200 400,125 400,275 300,200"
Stroke="Purple"
StrokeThickness="2">
<Polygon.Fill>
<SolidColorBrush Color="Blue" Opacity="0.4"/>
</Polygon.Fill>
</Polygon>

Makes a left pointing triangle, purple outline and blue body

=== 2015 ===

*'''Animation.cs''' (animation of opening screen): This is where we can set the number of images, frames, and the rate they play at, currently all images in 30 seconds. We may want that to run faster. The images you will make for the ship de-cloaking will be located in Resources / Images / Animation.
* \supremacyclient\'''ClientModule.cs''':
**Found a place to add the right mouse click instructions for the Panel Access Menu. A thing called the statusWindow held the text "loading" while you wait for a game to load. Added the information there for new players

*FMOD is partly replace by AudioEngine.cs and others - just find it out

=== 2014 ===

== some code ==

for Theme and UI see >> '''[[Theme]]'''

=== miscellaneous ===

*Mainline\SupremacyClient\GameContextMenu.cs

*\Mainline\SupremacyUI\SystemProductionPanel.cs

*\Mainline\SupremacyCore\Orbitals\FleetOrders.cs -> all items inside a sector

*Mainline\SupremacyClient\GameContextMenu.cs (Access Popup Menu - or use F1 to F5)

*\Mainline\SupremacyClientComponents\Controls\InfoCard\InfoCard.cs (-> Tooltips ??)
**\Mainline\SupremacyClient\themes\Federation\InfoCard.xaml -> <Setter Property="Width" Value="500" /> (BEFORE: 250)

*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyPlanetaryBuildQueueView.xaml - Colonies Screen Content

*\Mainline\SupremacyCore\Universe\Colony.cs
*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyStructureListView.xaml
**Size of this area: 720 x 240

*\Mainline\SupremacyClient\Views\GalaxyScreen\TaskForceListView.xaml

=== Version Number ===

Look for version number control in AssemblyInfo.cs

your hard disk code folder BotF2\SupremacyClient\Properties\AssemblyInfo.cs

---
example code: (put in your current star date)

*[assembly: AssemblyVersion("2018.11.20.0")]
*[assembly: AssemblyFileVersion("2018.11.20.0")]

=== Ships ===

*\Fleets.cs
*\FleetOrder.cs (without a "s" - beware of it)
*\FleetOrders.cs

*\mainline\supremacyclientcomponents\views\galaxyscreen\galaxyscreenpresenter.cs TaskForcesList

==== Building Ships ====

*Cancelling -> Breakpoint at Line 185 at OnShipyardBuildProjectsChanged() \Mainline\SupremacyClientComponents\Views\ColonyScreen\ColonyScreenPresentationModel.cs

=== Sounds ===

*\Mainline\SupremacyClient\AudioEngine.cs (for Music), for Sounds >> SoundPlayerAction is used (search for \Resources\UI\Federation\SoundsButtonClick.wav)
*and in \Mainline\SupremacyClientComponents\Views\SystemAssaultScreen\SystemAssaultScreenViewModel.cs -> Uri is used (e.g. CombatLaser.wav)

=== Galaxy Generator ===

*\Mainline\SupremacyCore\Universe\GalaxyGenerator.cs

=== Values ===
*CivID: 0 = Federation...

=== TurnPhase ===

WaitOnPlayers = 0,
PreTurnOperations,
ResetObjects,
FleetMovement,
Combat,
PopulationGrowth,
PersonnelTraining,
Research,
Scrapping,
Maintenance,
ShipProduction,
Production,
Trade,
Morale,
MapUpdates,
PostTurnOperations,
SendUpdates,
Diplomacy,
WaitOnAIPlayers

=== older list ===

{|class="wikitable sortable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |where
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Folder
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |File
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Function
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Date
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Description
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameContext.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
initialising game
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|
Raw Materials, Deuterium, Dilithium is collected cross over all colonies and used by all colonies
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoShipProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|

|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Combat
|style=text-align:center|InvasionArena.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
SystemAssault
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Orbital
|style=text-align:center|Shipyard.cs
|style=text-align:center|GetBuildOutput(int slot)
|style=text-align:center| [https://bitbucket.org/Bloodwurm/BotF2dev/commits/1aafc8f6e47e9e3b9c20de79f2d02f197c023d63 2014-01-15]
|style=text-align:left|
just selects output (active?) and bonus (BonusType.PercentShipBuilding), since 2014-01-15 also case PopulationRatio or IndustryRatio
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|GetProductionOutput(ProductionCategory category)
|style=text-align:center|
|style=text-align:left|
see last line, too !
*Food: minimum 10
*Research:
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*Industry: '''minimum 10 !'''
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*last line: return ((int)(baseOutput + (baseOutput * modifier.Efficiency)) + modifier.Bonus);
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasFoodBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasFoodBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasEnergyBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasEnergyBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-ClientComp
|style=text-align:center|Views\GalaxyScreen
|style=text-align:center|GalaxyScreenView.cs
|style=text-align:center|GalaxyScreenView()
|style=text-align:center|
|style=text-align:left|GalaxyView Hotkeys Definition (see [[Hotkey]]s)
|style=text-align:left|
|style=text-align:left|

|}

== Botf2-coding-practice ==

*http://star-trek-supremacy.proboards.com/thread/349/botf2-coding-practice (intern)

*prepare:
**...we are using SourceTree, provided by bitbucket (another option: TortoiseHg with Mercurial - to access the supremacy code repository http://tortoisehg.bitbucket.org/)
**PuTTYgen - to generate a ssh key to allow using ssh protocol instead of slow https http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
***or use C:\Program Files (x86)\Atlassian\SourceTree\tools\putty..puttygen.exe....generate a key (using a phrase is not neccessary)
***copy the public key (4-5 lines) into your bitbucket account/profile under SSH Keys, label it with any title and CopyPaste
**we are using Visual Studio Community 2013 Update 4 (select the Community Version) https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
**we are not(!) using Visual Studio Community 2015 RC - to compile the code (ISO is recommend)....still need to check if Supremacy code compiles with it, so instead we might need to depend on VS2013 http://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs....for VS 2015 we read to create a new project, import Supremacy and go through all the issues
**you also need to have an account on http://bitbucket.org
**and you should have Skype installed to participate in the meetings we have

*when you attempt to clone by ssh instead of https, check the following tutorial: http://confluence.atlassian.com/display/BITBUCKET/Set+up+SSH+for+Mercurial

*here some simple text editors useful to edit stuff like xml files, just pick the one you prefer they all are great:
**http://www.sublimetext.com/
**http://www.contexteditor.org/index.php
**http://notepad-plus-plus.org/ (used by reg atm)

== SourceTree ==

*Download >> https://www.sourcetreeapp.com/?v=win (or while cloning...use the link below blue Clone Button)

*Tools: 3rd point: OPTIONS

*SSH Client Configuration:
**SSH Key: c:\....\ReginaldPutty.ppk
**SSH Client: (IMPORTANT) PuTTY/Link (not SSH !!)
**automatically start: yes

== Visual Studio ==

It's possible (and standard) to compile the game with Visual Studio. No further stuff of programs is needed, except matching Resources folder. Mention that the compiled exe is then in \Mainline\bin\Debug (or \Release).

=== Visual C++ Library ===

IMPORTANT: As Microsoft no longer provides Visual C++ Library as standard installed component ...don't forget to select or install this manually! In VS you can recognize it if \Supremacy Native is unload (sign is greyed out a little bit)

==== SupremacyNative ====

SupremacyNative is C++ coded. Sometimes there are some problems with it https://developercommunity.visualstudio.com/content/problem/312852/internal-compiler-error-in-vs158-msc1cpp-line-1518.html

=== VS2019 ===

* meanwhile we are on VS 2019 Community version https://www.visualstudio.com/downloads

=== VS2017 ===

In May 2017 we're trying to change to VS 2017 Community version https://www.visualstudio.com/downloads

*you might want to change language at TOOLS > OPTIONS > ENVIROMENT > INTERNATIONAL SETTINGS

* first make a clean !!, maybe for each single project (10 of 10)

* SOLUTION EXPLORER - right mouse click - retarget (in the middle) - select newest versions

* (this should be only needed once and should be uploaded to Repository by one guy) SupremacyClient > Set as start Project

*after cleaning maybe use REBUILD

for more see >> [[#Tools|here]]

=== VS2015 ===

since April 2016 we're using VS 2015

*Visual Studio '''Community''' 2015 RC - to compile the code (ISO is recommend) ... still need to check if Supremacy code compiles with it, so instead we might need VS2013. NEW: we try to go to VS 2015 now.
https://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs - you need the "Community" Version, currently (Apr 2016) version "Update 2"

==== VS 2015 Update 3 ====

*says it does uninstall Update 2
*needs update to 33 GB to install (only if every is selected) - seems to need some hours...

=== old VS ===

*Visual Studio Community 2013 (Community version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2012 (Express version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2008 (German) http://www.microsoft.com/de-de/download/details.aspx?id=13276

=== Tools ===

*Indent Guides https://visualstudiogallery.msdn.microsoft.com/e792686d-542b-474a-8c55-630980e72c30 Adds vertical lines at each indent level.

* Vertical tabs https://marketplace.visualstudio.com/items?itemName=VisualStudioProductTeam.ProductivityPowerPack2017

*PowerShell Tools für VS 2015

=== Tips ===
*TOOLS > OPTIONS > ENVIRONMENT > Color theme -> Black

*TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Detect when file is changed outside... -> Yes
**TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Reload modified files... -> Yes

*DEBUG > OPTIONS > PROJECTS... > BUILD AND RUN > when code=project is changed="out of date" > "Always Build" (checkbox "only build ...on Run" is marked)
**https://www.vb-paradise.de/index.php/Thread/47935-Code-bei-Klick-auf-Debugging-starten-kompilieren-wenn-er-sich-ge%C3%A4ndert-hat/

*TOOLS > OPTIONS > TEXT EDITOR > ALL LANGUAGES > Line Number (activate for all)

*DEBUG > SUPREMACY CLIENT PROPERTIES (last) > DEBUG > Start project > Command line arguments: "-aiexplore -SAVEDGAME:auto" (if you save in Supremacy manually a game with name "auto" (independent from game's "(autosave)", this manually saved game can be loaded at startup.
**"-aiexplore" isn't necessary. For more see [[Command line parameter]]
**if working for example on Cardassian UI just save Cardassian as "auto".
**when you want to change to Klingons, just retire and start Klingons. If you want to work steady on Klingons, save a Klingon's game with auto.
**if you want to start a new game steady, just go Command line arguments (see above) and change the filename to an unused one like "-SAVEDGAME:auto123"

*activate Toolbar BUILD by right mouse click on Toolbar line

* Tools -> Options -> Debugging -> Output Window -> Module Load Messages -> Off

==== Editor ====
we're using some different editors
*one option is to drag'n'drop files like xml to Visual Studio
*sometimes we use Notepad++ https://notepad-plus-plus.org/download with Extension Compare (PLUGINS > PLUGIN MANAGER > SHOW P-Manager > "Compare" ...install
*for a black style we use Sublime http://www.sublimetext.com/2

==== Screenshot ====

*reg likes Greenshot http://getgreenshot.org/
**puts an icon into task bar. There: > PREFERENCES
***PREFERENCES > GENERAL: reg uses for "Capture region" CRTL+PRNT (and no other hotkey)
***PREFERENCES > OUTPUT: define a folder at "Storage location" and a standard file type (default is *.png)
***PREFERENCES > DESTINATION: (reg's settings)
****- turn off "Select destination dymnamically"
****- open in image editor
****- copy to clipboard
**Usage:
***press Hotkey and make Screenshot
***paste immediately anywhere OR
***work on it inside Greenshot (give red circles or mark up in any colour), give numbers, obfuscate and more
***save or save as jpg or print

== Compiling ==

if you have an error with "Glyphs.xaml", than make sure you have copied \Resources MANUALLY into the output folders - this was changed in 2015. The output folder depends on compiling method "Debug" or "Release", it is
*for DEBUG _: (YourRepositoryFolder)\Mainline\bin\'''Debug\Resources''' or
*for RELEASE: (YourRepositoryFolder)\Mainline\bin\'''Release\Resources'''

it's creating:
*1> Supremacy.Scripting -> %path_repo%\bin\Debug\lib\Supremacy.Scripting.dll
*2> SupremacyCore -> %path_repo%\bin\Debug\lib\SupremacyCore.dll
*3> Supremacy.Xna -> %path_repo%\bin\Debug\lib\Supremacy.Xna.dll
*4> SupremacyClientComponents -> %path_repo%\bin\Debug\lib\SupremacyClientComponents.dll
*5> SupremacyWPF -> %path_repo%\bin\Debug\lib\SupremacyWPF.dll
*6> SupremacyService -> %path_repo%\bin\Debug\lib\SupremacyService.dll
*7> SupremacyUI -> %path_repo%\bin\Debug\lib\SupremacyUI.dll

== Visual C# ==

build in Visual Studio

<img>http://botf2.square7.ch/wiki-files/images/VS2015.jpg</img>

== SunBurn ==

SunBurn is on hold for now. Kenneth was working sometimes with SunBurn...this might be a site for this http://channel9.msdn.com/coding4fun/blog/No-need-for-sunscreen-you-want-this-SunBurn-SunBurn-v2-RTMs-including-the-free-SunBurn-Framework-Edi

*http://en.wikipedia.org/wiki/List_of_game_engines

== .Net ==

you should use latest [http://www.microsoft.com/net .Net-version] (2014: version 4.5.1)

== XNA ==

"Could not load file or assembly 'Microsoft.Xna.Framework.dll' or one of its dependencies. The specified module could not be found."

*suggestion by reg: go to \Resources\Models and rename the "Models"-folder to "Models-SetOffline" or something else (if building a ship no model is shown -as it is to most of the ships- but otherwise the game could work fine)

This suggests the problem is with your XNA installation. The game uses XNA to display the 3D ship models in the shipyard. There's no way to disable the models so XNA wouldn't be needed. So to be able to play the game, i'd advise to uninstall XNA, then install the latest version.

XNA 3.1 (this one you need in any case): http://www.microsoft.com/en-us/download/details.aspx?id=15163

XNA 4.0 Download link: http://www.microsoft.com/en-gb/download/details.aspx?id=20914

== Try ==

(for boolean)

try
{
return true;
}
catch (Exception e)
{
var errors = new System.Collections.Concurrent.ConcurrentStack<Exception>();
errors.Push(e);
return false;
}
finally
{
xxx;
}
;

== Contexts ==

*AppContext (programm running)
*GameContext.Current (Game started - so after StartScreen)
*PlayerContext.Current

== Text ==
=== en.txt ===
* XAML expample: Text="{s:StringResource EMPIRES_HEADER}"
* string _text = String.Format(ResourceManager.GetString("KEY_IN-EN_TXT"),parameter1, parameter2;

== LocalPlayer ==

*AppContext.LocalPlayer (just inside XAML-code files ??)

== Civilization ==

just the data out of Civilization.xml ... for more see [[#CivilizationManager]]

== CivilizationManager ==

CivilizationManager holds all the data like amount of credits, diplomacy, sitreps and more

*GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

== GameLog ==

GameLog.Client.GameData.DebugFormat("Civilization.cs: isBorgPlayable={0}, _throwOutRace={1}, _civType before: {2}", isBorgPlayable, _throwOutRace, _civType);

== MessageBox (Windows Style) ==

MessageBox.Show("Borg turned into Expanded", "WARNING", MessageBoxButton.OK);

== MessageDialog (Supremacy Style) ==

var result = MessageDialog.Show("Borg turned into Expanded", MessageDialogButtons.YesNo);

== SoundPlaying ==

* _soundPlayer.PlayFile("Resources/SoundFX/ChatMessage.wav");

Source Code

2020-10-03T11:39:15Z

Reginald: /* en.txt */

== Source Code ==

http://guganeshan.com/blog/setting-up-git-and-tortoisegit-with-bitbucket-step-by-step.html

=== official ===

* code is now at https://github.com/BotF2/BotF2.git

*last source code https://bitbucket.org/mstrobel/supremacy/overview (it's in C#, also named CSharp. [[#Visual Studio]] is used for coding.)
**Mike's Post: build in [http://www.microsoft.com/downloads/dlx/en-us/ThankYou.aspx?FamilyID=75568AA6-8107-475D-948A-EF22627E57A5 VS2010] with .NET 4.0. You may need the [http://en.csharp-online.net/Download_Free_Microsoft_Visual_CSharp_.NET#Download_Microsoft_Visual_Studio_Async_Community_Technology_Preview_.28CTP.29 C# Async CTP]. http://bote2.square7.ch/forum/viewtopic.php?p=70790#p70790
**http://bote2.square7.ch/forum/viewtopic.php?p=70781#p70781
*** Supremacy.Game.GameEngine is where you'll find most of the game logic. That's where most of the turn processing happens.
*** The SupremacyCore project is where you'll find the foundation of the game.
*** SupremacyService is just the game server (all the important bits it interacts with are in SupremacyCore).
*** SupremacyClientComponents is UI infrastructure.
*** SupremacyUI and SupremacyWPF are older UI infrastructure stuff, much of which has been phased out and replaced by newer and better stuff in SupremacyClientComponents. The most interesting stuff in SupremacyUI is GalaxyGridPanel, which draws the galactic map. It also has the spinning planet views.
*** Supremacy.Xna is where the XNA/3D stuff is located--it's not used heavily yet, but it has some effects for the invasion screen, a newer star renderer, a 3D spinning ship renderer, etc.
*** Supremacy.Scripting is an expression language parser/compiler.
*** SupremacyClient is the main graphical client and has most of the game screen implementations.

*old source code can be taken from here: http://supremacy.codeplex.com/ (last upload from MStrobel at 03.01.2011)

==== ClientContext vs AppContext ====

taken from https://bitbucket.org/kflanagan/supremacydev/commits/0d562ce676425cd5da19cfdbcf1b6c18c7d0d135

*IClientContext is used by SupremacyCore to interface clients participating on a game, both local and over network. The IClientContext further includes an interface to IGameContext which gives access to the game data itself inside the '''SupremacyClient app'''
*However there should be an option to also include local properties not known to the Core, which is why this is done alternatively another context would have to be introduced for local data, but then still all the client code would have to be updated to make use of it

==== .XAML files ====

In Windows Presentation Foundation (WPF), a windows app framework used by Supremacy, XAML forms a user interface markup language to define UI elements, data binding, events, and other features.

Info resources:

*MS Article: [https://msdn.microsoft.com/en-us/library/ms745683(v=vs.110).aspx XAML Styling and Templating]

*Youtube video: [https://www.youtube.com/watch?v=0qE5hyuU9hE Introduction to XAML] (26min)

== Bitbucket ==

*https://confluence.atlassian.com/display/BITBUCKET/Maintaining+a+Mercurial+Repository

== Changes ==

see [[ChangeLog|here]] or https://bitbucket.org/mstrobel/supremacy/commits/branch/default

=== 2016 ===

==== XAML ====

*January 2016 [Planned]: Hope to get Major Race specific UI build through use of generic XAML files.
* ClientApp.xaml.cs has the code to direct UI to race specific folders of xaml files in SupremacyClient/themes/{0}

Looking at SystemScreen.xaml, Global.xaml and ClientModules.cs in Themes/SupremacyClient
See also generic.xaml in SupremacyClientComponents/Themes/InfoCard Theme.xaml Default.xaml Icons.xaml ClientApp.xaml.cs SystemScreen.xaml

1/17/16: Found that Mikes code in ClientApp.xaml.cs will already select for Major race. Need new folders for each major race in SupremacyClient/themes/(major race), edit paths to Resources in the .xaml files found in each races set of .xaml files. File names in SupremacyClient/themes/(major race) are not unique but content in Resources is. Now you can edit files in Resources for unique UI.

2/13/16:

<Polygon
Points="300,200 400,125 400,275 300,200"
Stroke="Purple"
StrokeThickness="2">
<Polygon.Fill>
<SolidColorBrush Color="Blue" Opacity="0.4"/>
</Polygon.Fill>
</Polygon>

Makes a left pointing triangle, purple outline and blue body

=== 2015 ===

*'''Animation.cs''' (animation of opening screen): This is where we can set the number of images, frames, and the rate they play at, currently all images in 30 seconds. We may want that to run faster. The images you will make for the ship de-cloaking will be located in Resources / Images / Animation.
* \supremacyclient\'''ClientModule.cs''':
**Found a place to add the right mouse click instructions for the Panel Access Menu. A thing called the statusWindow held the text "loading" while you wait for a game to load. Added the information there for new players

*FMOD is partly replace by AudioEngine.cs and others - just find it out

=== 2014 ===

== some code ==

for Theme and UI see >> '''[[Theme]]'''

=== miscellaneous ===

*Mainline\SupremacyClient\GameContextMenu.cs

*\Mainline\SupremacyUI\SystemProductionPanel.cs

*\Mainline\SupremacyCore\Orbitals\FleetOrders.cs -> all items inside a sector

*Mainline\SupremacyClient\GameContextMenu.cs (Access Popup Menu - or use F1 to F5)

*\Mainline\SupremacyClientComponents\Controls\InfoCard\InfoCard.cs (-> Tooltips ??)
**\Mainline\SupremacyClient\themes\Federation\InfoCard.xaml -> <Setter Property="Width" Value="500" /> (BEFORE: 250)

*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyPlanetaryBuildQueueView.xaml - Colonies Screen Content

*\Mainline\SupremacyCore\Universe\Colony.cs
*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyStructureListView.xaml
**Size of this area: 720 x 240

*\Mainline\SupremacyClient\Views\GalaxyScreen\TaskForceListView.xaml

=== Version Number ===

Look for version number control in AssemblyInfo.cs

your hard disk code folder BotF2\SupremacyClient\Properties\AssemblyInfo.cs

---
example code: (put in your current star date)

*[assembly: AssemblyVersion("2018.11.20.0")]
*[assembly: AssemblyFileVersion("2018.11.20.0")]

=== Ships ===

*\Fleets.cs
*\FleetOrder.cs (without a "s" - beware of it)
*\FleetOrders.cs

*\mainline\supremacyclientcomponents\views\galaxyscreen\galaxyscreenpresenter.cs TaskForcesList

==== Building Ships ====

*Cancelling -> Breakpoint at Line 185 at OnShipyardBuildProjectsChanged() \Mainline\SupremacyClientComponents\Views\ColonyScreen\ColonyScreenPresentationModel.cs

=== Sounds ===

*\Mainline\SupremacyClient\AudioEngine.cs (for Music), for Sounds >> SoundPlayerAction is used (search for \Resources\UI\Federation\SoundsButtonClick.wav)
*and in \Mainline\SupremacyClientComponents\Views\SystemAssaultScreen\SystemAssaultScreenViewModel.cs -> Uri is used (e.g. CombatLaser.wav)

=== Galaxy Generator ===

*\Mainline\SupremacyCore\Universe\GalaxyGenerator.cs

=== Values ===
*CivID: 0 = Federation...

=== TurnPhase ===

WaitOnPlayers = 0,
PreTurnOperations,
ResetObjects,
FleetMovement,
Combat,
PopulationGrowth,
PersonnelTraining,
Research,
Scrapping,
Maintenance,
ShipProduction,
Production,
Trade,
Morale,
MapUpdates,
PostTurnOperations,
SendUpdates,
Diplomacy,
WaitOnAIPlayers

=== older list ===

{|class="wikitable sortable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |where
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Folder
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |File
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Function
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Date
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Description
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameContext.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
initialising game
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|
Raw Materials, Deuterium, Dilithium is collected cross over all colonies and used by all colonies
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoShipProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|

|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Combat
|style=text-align:center|InvasionArena.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
SystemAssault
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Orbital
|style=text-align:center|Shipyard.cs
|style=text-align:center|GetBuildOutput(int slot)
|style=text-align:center| [https://bitbucket.org/Bloodwurm/BotF2dev/commits/1aafc8f6e47e9e3b9c20de79f2d02f197c023d63 2014-01-15]
|style=text-align:left|
just selects output (active?) and bonus (BonusType.PercentShipBuilding), since 2014-01-15 also case PopulationRatio or IndustryRatio
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|GetProductionOutput(ProductionCategory category)
|style=text-align:center|
|style=text-align:left|
see last line, too !
*Food: minimum 10
*Research:
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*Industry: '''minimum 10 !'''
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*last line: return ((int)(baseOutput + (baseOutput * modifier.Efficiency)) + modifier.Bonus);
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasFoodBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasFoodBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasEnergyBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasEnergyBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-ClientComp
|style=text-align:center|Views\GalaxyScreen
|style=text-align:center|GalaxyScreenView.cs
|style=text-align:center|GalaxyScreenView()
|style=text-align:center|
|style=text-align:left|GalaxyView Hotkeys Definition (see [[Hotkey]]s)
|style=text-align:left|
|style=text-align:left|

|}

== Botf2-coding-practice ==

*http://star-trek-supremacy.proboards.com/thread/349/botf2-coding-practice (intern)

*prepare:
**...we are using SourceTree, provided by bitbucket (another option: TortoiseHg with Mercurial - to access the supremacy code repository http://tortoisehg.bitbucket.org/)
**PuTTYgen - to generate a ssh key to allow using ssh protocol instead of slow https http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
***or use C:\Program Files (x86)\Atlassian\SourceTree\tools\putty..puttygen.exe....generate a key (using a phrase is not neccessary)
***copy the public key (4-5 lines) into your bitbucket account/profile under SSH Keys, label it with any title and CopyPaste
**we are using Visual Studio Community 2013 Update 4 (select the Community Version) https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
**we are not(!) using Visual Studio Community 2015 RC - to compile the code (ISO is recommend)....still need to check if Supremacy code compiles with it, so instead we might need to depend on VS2013 http://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs....for VS 2015 we read to create a new project, import Supremacy and go through all the issues
**you also need to have an account on http://bitbucket.org
**and you should have Skype installed to participate in the meetings we have

*when you attempt to clone by ssh instead of https, check the following tutorial: http://confluence.atlassian.com/display/BITBUCKET/Set+up+SSH+for+Mercurial

*here some simple text editors useful to edit stuff like xml files, just pick the one you prefer they all are great:
**http://www.sublimetext.com/
**http://www.contexteditor.org/index.php
**http://notepad-plus-plus.org/ (used by reg atm)

== SourceTree ==

*Download >> https://www.sourcetreeapp.com/?v=win (or while cloning...use the link below blue Clone Button)

*Tools: 3rd point: OPTIONS

*SSH Client Configuration:
**SSH Key: c:\....\ReginaldPutty.ppk
**SSH Client: (IMPORTANT) PuTTY/Link (not SSH !!)
**automatically start: yes

== Visual Studio ==

It's possible (and standard) to compile the game with Visual Studio. No further stuff of programs is needed, except matching Resources folder. Mention that the compiled exe is then in \Mainline\bin\Debug (or \Release).

=== Visual C++ Library ===

IMPORTANT: As Microsoft no longer provides Visual C++ Library as standard installed component ...don't forget to select or install this manually! In VS you can recognize it if \Supremacy Native is unload (sign is greyed out a little bit)

==== SupremacyNative ====

SupremacyNative is C++ coded. Sometimes there are some problems with it https://developercommunity.visualstudio.com/content/problem/312852/internal-compiler-error-in-vs158-msc1cpp-line-1518.html

=== VS2019 ===

* meanwhile we are on VS 2019 Community version https://www.visualstudio.com/downloads

=== VS2017 ===

In May 2017 we're trying to change to VS 2017 Community version https://www.visualstudio.com/downloads

*you might want to change language at TOOLS > OPTIONS > ENVIROMENT > INTERNATIONAL SETTINGS

* first make a clean !!, maybe for each single project (10 of 10)

* SOLUTION EXPLORER - right mouse click - retarget (in the middle) - select newest versions

* (this should be only needed once and should be uploaded to Repository by one guy) SupremacyClient > Set as start Project

*after cleaning maybe use REBUILD

for more see >> [[#Tools|here]]

=== VS2015 ===

since April 2016 we're using VS 2015

*Visual Studio '''Community''' 2015 RC - to compile the code (ISO is recommend) ... still need to check if Supremacy code compiles with it, so instead we might need VS2013. NEW: we try to go to VS 2015 now.
https://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs - you need the "Community" Version, currently (Apr 2016) version "Update 2"

==== VS 2015 Update 3 ====

*says it does uninstall Update 2
*needs update to 33 GB to install (only if every is selected) - seems to need some hours...

=== old VS ===

*Visual Studio Community 2013 (Community version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2012 (Express version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2008 (German) http://www.microsoft.com/de-de/download/details.aspx?id=13276

=== Tools ===

*Indent Guides https://visualstudiogallery.msdn.microsoft.com/e792686d-542b-474a-8c55-630980e72c30 Adds vertical lines at each indent level.

* Vertical tabs https://marketplace.visualstudio.com/items?itemName=VisualStudioProductTeam.ProductivityPowerPack2017

*PowerShell Tools für VS 2015

=== Tips ===
*TOOLS > OPTIONS > ENVIRONMENT > Color theme -> Black

*TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Detect when file is changed outside... -> Yes
**TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Reload modified files... -> Yes

*DEBUG > OPTIONS > PROJECTS... > BUILD AND RUN > when code=project is changed="out of date" > "Always Build" (checkbox "only build ...on Run" is marked)
**https://www.vb-paradise.de/index.php/Thread/47935-Code-bei-Klick-auf-Debugging-starten-kompilieren-wenn-er-sich-ge%C3%A4ndert-hat/

*TOOLS > OPTIONS > TEXT EDITOR > ALL LANGUAGES > Line Number (activate for all)

*DEBUG > SUPREMACY CLIENT PROPERTIES (last) > DEBUG > Start project > Command line arguments: "-aiexplore -SAVEDGAME:auto" (if you save in Supremacy manually a game with name "auto" (independent from game's "(autosave)", this manually saved game can be loaded at startup.
**"-aiexplore" isn't necessary. For more see [[Command line parameter]]
**if working for example on Cardassian UI just save Cardassian as "auto".
**when you want to change to Klingons, just retire and start Klingons. If you want to work steady on Klingons, save a Klingon's game with auto.
**if you want to start a new game steady, just go Command line arguments (see above) and change the filename to an unused one like "-SAVEDGAME:auto123"

*activate Toolbar BUILD by right mouse click on Toolbar line

* Tools -> Options -> Debugging -> Output Window -> Module Load Messages -> Off

==== Editor ====
we're using some different editors
*one option is to drag'n'drop files like xml to Visual Studio
*sometimes we use Notepad++ https://notepad-plus-plus.org/download with Extension Compare (PLUGINS > PLUGIN MANAGER > SHOW P-Manager > "Compare" ...install
*for a black style we use Sublime http://www.sublimetext.com/2

==== Screenshot ====

*reg likes Greenshot http://getgreenshot.org/
**puts an icon into task bar. There: > PREFERENCES
***PREFERENCES > GENERAL: reg uses for "Capture region" CRTL+PRNT (and no other hotkey)
***PREFERENCES > OUTPUT: define a folder at "Storage location" and a standard file type (default is *.png)
***PREFERENCES > DESTINATION: (reg's settings)
****- turn off "Select destination dymnamically"
****- open in image editor
****- copy to clipboard
**Usage:
***press Hotkey and make Screenshot
***paste immediately anywhere OR
***work on it inside Greenshot (give red circles or mark up in any colour), give numbers, obfuscate and more
***save or save as jpg or print

== Compiling ==

if you have an error with "Glyphs.xaml", than make sure you have copied \Resources MANUALLY into the output folders - this was changed in 2015. The output folder depends on compiling method "Debug" or "Release", it is
*for DEBUG _: (YourRepositoryFolder)\Mainline\bin\'''Debug\Resources''' or
*for RELEASE: (YourRepositoryFolder)\Mainline\bin\'''Release\Resources'''

it's creating:
*1> Supremacy.Scripting -> %path_repo%\bin\Debug\lib\Supremacy.Scripting.dll
*2> SupremacyCore -> %path_repo%\bin\Debug\lib\SupremacyCore.dll
*3> Supremacy.Xna -> %path_repo%\bin\Debug\lib\Supremacy.Xna.dll
*4> SupremacyClientComponents -> %path_repo%\bin\Debug\lib\SupremacyClientComponents.dll
*5> SupremacyWPF -> %path_repo%\bin\Debug\lib\SupremacyWPF.dll
*6> SupremacyService -> %path_repo%\bin\Debug\lib\SupremacyService.dll
*7> SupremacyUI -> %path_repo%\bin\Debug\lib\SupremacyUI.dll

== Visual C# ==

build in Visual Studio

<img>http://botf2.square7.ch/wiki-files/images/VS2015.jpg</img>

== SunBurn ==

SunBurn is on hold for now. Kenneth was working sometimes with SunBurn...this might be a site for this http://channel9.msdn.com/coding4fun/blog/No-need-for-sunscreen-you-want-this-SunBurn-SunBurn-v2-RTMs-including-the-free-SunBurn-Framework-Edi

*http://en.wikipedia.org/wiki/List_of_game_engines

== .Net ==

you should use latest [http://www.microsoft.com/net .Net-version] (2014: version 4.5.1)

== XNA ==

"Could not load file or assembly 'Microsoft.Xna.Framework.dll' or one of its dependencies. The specified module could not be found."

*suggestion by reg: go to \Resources\Models and rename the "Models"-folder to "Models-SetOffline" or something else (if building a ship no model is shown -as it is to most of the ships- but otherwise the game could work fine)

This suggests the problem is with your XNA installation. The game uses XNA to display the 3D ship models in the shipyard. There's no way to disable the models so XNA wouldn't be needed. So to be able to play the game, i'd advise to uninstall XNA, then install the latest version.

XNA 3.1 (this one you need in any case): http://www.microsoft.com/en-us/download/details.aspx?id=15163

XNA 4.0 Download link: http://www.microsoft.com/en-gb/download/details.aspx?id=20914

== Try ==

(for boolean)

try
{
return true;
}
catch (Exception e)
{
var errors = new System.Collections.Concurrent.ConcurrentStack<Exception>();
errors.Push(e);
return false;
}
finally
{
xxx;
}
;

== Contexts ==

*AppContext (programm running)
*GameContext.Current (Game started - so after StartScreen)
*PlayerContext.Current

== Text ==
=== en.txt ===
* XAML expample: Text="{s:StringResource EMPIRES_HEADER}"
* String.Format(ResourceManager.GetString("KEY_IN-EN_TXT"),parameter1, parameter2;

== LocalPlayer ==

*AppContext.LocalPlayer (just inside XAML-code files ??)

== Civilization ==

just the data out of Civilization.xml ... for more see [[#CivilizationManager]]

== CivilizationManager ==

CivilizationManager holds all the data like amount of credits, diplomacy, sitreps and more

*GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

== GameLog ==

GameLog.Client.GameData.DebugFormat("Civilization.cs: isBorgPlayable={0}, _throwOutRace={1}, _civType before: {2}", isBorgPlayable, _throwOutRace, _civType);

== MessageBox (Windows Style) ==

MessageBox.Show("Borg turned into Expanded", "WARNING", MessageBoxButton.OK);

== MessageDialog (Supremacy Style) ==

var result = MessageDialog.Show("Borg turned into Expanded", MessageDialogButtons.YesNo);

== SoundPlaying ==

* _soundPlayer.PlayFile("Resources/SoundFX/ChatMessage.wav");

Source Code

2020-10-03T11:33:31Z

Reginald: /* Contexts */

== Source Code ==

http://guganeshan.com/blog/setting-up-git-and-tortoisegit-with-bitbucket-step-by-step.html

=== official ===

* code is now at https://github.com/BotF2/BotF2.git

*last source code https://bitbucket.org/mstrobel/supremacy/overview (it's in C#, also named CSharp. [[#Visual Studio]] is used for coding.)
**Mike's Post: build in [http://www.microsoft.com/downloads/dlx/en-us/ThankYou.aspx?FamilyID=75568AA6-8107-475D-948A-EF22627E57A5 VS2010] with .NET 4.0. You may need the [http://en.csharp-online.net/Download_Free_Microsoft_Visual_CSharp_.NET#Download_Microsoft_Visual_Studio_Async_Community_Technology_Preview_.28CTP.29 C# Async CTP]. http://bote2.square7.ch/forum/viewtopic.php?p=70790#p70790
**http://bote2.square7.ch/forum/viewtopic.php?p=70781#p70781
*** Supremacy.Game.GameEngine is where you'll find most of the game logic. That's where most of the turn processing happens.
*** The SupremacyCore project is where you'll find the foundation of the game.
*** SupremacyService is just the game server (all the important bits it interacts with are in SupremacyCore).
*** SupremacyClientComponents is UI infrastructure.
*** SupremacyUI and SupremacyWPF are older UI infrastructure stuff, much of which has been phased out and replaced by newer and better stuff in SupremacyClientComponents. The most interesting stuff in SupremacyUI is GalaxyGridPanel, which draws the galactic map. It also has the spinning planet views.
*** Supremacy.Xna is where the XNA/3D stuff is located--it's not used heavily yet, but it has some effects for the invasion screen, a newer star renderer, a 3D spinning ship renderer, etc.
*** Supremacy.Scripting is an expression language parser/compiler.
*** SupremacyClient is the main graphical client and has most of the game screen implementations.

*old source code can be taken from here: http://supremacy.codeplex.com/ (last upload from MStrobel at 03.01.2011)

==== ClientContext vs AppContext ====

taken from https://bitbucket.org/kflanagan/supremacydev/commits/0d562ce676425cd5da19cfdbcf1b6c18c7d0d135

*IClientContext is used by SupremacyCore to interface clients participating on a game, both local and over network. The IClientContext further includes an interface to IGameContext which gives access to the game data itself inside the '''SupremacyClient app'''
*However there should be an option to also include local properties not known to the Core, which is why this is done alternatively another context would have to be introduced for local data, but then still all the client code would have to be updated to make use of it

==== .XAML files ====

In Windows Presentation Foundation (WPF), a windows app framework used by Supremacy, XAML forms a user interface markup language to define UI elements, data binding, events, and other features.

Info resources:

*MS Article: [https://msdn.microsoft.com/en-us/library/ms745683(v=vs.110).aspx XAML Styling and Templating]

*Youtube video: [https://www.youtube.com/watch?v=0qE5hyuU9hE Introduction to XAML] (26min)

== Bitbucket ==

*https://confluence.atlassian.com/display/BITBUCKET/Maintaining+a+Mercurial+Repository

== Changes ==

see [[ChangeLog|here]] or https://bitbucket.org/mstrobel/supremacy/commits/branch/default

=== 2016 ===

==== XAML ====

*January 2016 [Planned]: Hope to get Major Race specific UI build through use of generic XAML files.
* ClientApp.xaml.cs has the code to direct UI to race specific folders of xaml files in SupremacyClient/themes/{0}

Looking at SystemScreen.xaml, Global.xaml and ClientModules.cs in Themes/SupremacyClient
See also generic.xaml in SupremacyClientComponents/Themes/InfoCard Theme.xaml Default.xaml Icons.xaml ClientApp.xaml.cs SystemScreen.xaml

1/17/16: Found that Mikes code in ClientApp.xaml.cs will already select for Major race. Need new folders for each major race in SupremacyClient/themes/(major race), edit paths to Resources in the .xaml files found in each races set of .xaml files. File names in SupremacyClient/themes/(major race) are not unique but content in Resources is. Now you can edit files in Resources for unique UI.

2/13/16:

<Polygon
Points="300,200 400,125 400,275 300,200"
Stroke="Purple"
StrokeThickness="2">
<Polygon.Fill>
<SolidColorBrush Color="Blue" Opacity="0.4"/>
</Polygon.Fill>
</Polygon>

Makes a left pointing triangle, purple outline and blue body

=== 2015 ===

*'''Animation.cs''' (animation of opening screen): This is where we can set the number of images, frames, and the rate they play at, currently all images in 30 seconds. We may want that to run faster. The images you will make for the ship de-cloaking will be located in Resources / Images / Animation.
* \supremacyclient\'''ClientModule.cs''':
**Found a place to add the right mouse click instructions for the Panel Access Menu. A thing called the statusWindow held the text "loading" while you wait for a game to load. Added the information there for new players

*FMOD is partly replace by AudioEngine.cs and others - just find it out

=== 2014 ===

== some code ==

for Theme and UI see >> '''[[Theme]]'''

=== miscellaneous ===

*Mainline\SupremacyClient\GameContextMenu.cs

*\Mainline\SupremacyUI\SystemProductionPanel.cs

*\Mainline\SupremacyCore\Orbitals\FleetOrders.cs -> all items inside a sector

*Mainline\SupremacyClient\GameContextMenu.cs (Access Popup Menu - or use F1 to F5)

*\Mainline\SupremacyClientComponents\Controls\InfoCard\InfoCard.cs (-> Tooltips ??)
**\Mainline\SupremacyClient\themes\Federation\InfoCard.xaml -> <Setter Property="Width" Value="500" /> (BEFORE: 250)

*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyPlanetaryBuildQueueView.xaml - Colonies Screen Content

*\Mainline\SupremacyCore\Universe\Colony.cs
*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyStructureListView.xaml
**Size of this area: 720 x 240

*\Mainline\SupremacyClient\Views\GalaxyScreen\TaskForceListView.xaml

=== Version Number ===

Look for version number control in AssemblyInfo.cs

your hard disk code folder BotF2\SupremacyClient\Properties\AssemblyInfo.cs

---
example code: (put in your current star date)

*[assembly: AssemblyVersion("2018.11.20.0")]
*[assembly: AssemblyFileVersion("2018.11.20.0")]

=== Ships ===

*\Fleets.cs
*\FleetOrder.cs (without a "s" - beware of it)
*\FleetOrders.cs

*\mainline\supremacyclientcomponents\views\galaxyscreen\galaxyscreenpresenter.cs TaskForcesList

==== Building Ships ====

*Cancelling -> Breakpoint at Line 185 at OnShipyardBuildProjectsChanged() \Mainline\SupremacyClientComponents\Views\ColonyScreen\ColonyScreenPresentationModel.cs

=== Sounds ===

*\Mainline\SupremacyClient\AudioEngine.cs (for Music), for Sounds >> SoundPlayerAction is used (search for \Resources\UI\Federation\SoundsButtonClick.wav)
*and in \Mainline\SupremacyClientComponents\Views\SystemAssaultScreen\SystemAssaultScreenViewModel.cs -> Uri is used (e.g. CombatLaser.wav)

=== Galaxy Generator ===

*\Mainline\SupremacyCore\Universe\GalaxyGenerator.cs

=== Values ===
*CivID: 0 = Federation...

=== TurnPhase ===

WaitOnPlayers = 0,
PreTurnOperations,
ResetObjects,
FleetMovement,
Combat,
PopulationGrowth,
PersonnelTraining,
Research,
Scrapping,
Maintenance,
ShipProduction,
Production,
Trade,
Morale,
MapUpdates,
PostTurnOperations,
SendUpdates,
Diplomacy,
WaitOnAIPlayers

=== older list ===

{|class="wikitable sortable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |where
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Folder
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |File
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Function
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Date
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Description
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameContext.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
initialising game
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|
Raw Materials, Deuterium, Dilithium is collected cross over all colonies and used by all colonies
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoShipProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|

|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Combat
|style=text-align:center|InvasionArena.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
SystemAssault
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Orbital
|style=text-align:center|Shipyard.cs
|style=text-align:center|GetBuildOutput(int slot)
|style=text-align:center| [https://bitbucket.org/Bloodwurm/BotF2dev/commits/1aafc8f6e47e9e3b9c20de79f2d02f197c023d63 2014-01-15]
|style=text-align:left|
just selects output (active?) and bonus (BonusType.PercentShipBuilding), since 2014-01-15 also case PopulationRatio or IndustryRatio
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|GetProductionOutput(ProductionCategory category)
|style=text-align:center|
|style=text-align:left|
see last line, too !
*Food: minimum 10
*Research:
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*Industry: '''minimum 10 !'''
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*last line: return ((int)(baseOutput + (baseOutput * modifier.Efficiency)) + modifier.Bonus);
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasFoodBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasFoodBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasEnergyBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasEnergyBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-ClientComp
|style=text-align:center|Views\GalaxyScreen
|style=text-align:center|GalaxyScreenView.cs
|style=text-align:center|GalaxyScreenView()
|style=text-align:center|
|style=text-align:left|GalaxyView Hotkeys Definition (see [[Hotkey]]s)
|style=text-align:left|
|style=text-align:left|

|}

== Botf2-coding-practice ==

*http://star-trek-supremacy.proboards.com/thread/349/botf2-coding-practice (intern)

*prepare:
**...we are using SourceTree, provided by bitbucket (another option: TortoiseHg with Mercurial - to access the supremacy code repository http://tortoisehg.bitbucket.org/)
**PuTTYgen - to generate a ssh key to allow using ssh protocol instead of slow https http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
***or use C:\Program Files (x86)\Atlassian\SourceTree\tools\putty..puttygen.exe....generate a key (using a phrase is not neccessary)
***copy the public key (4-5 lines) into your bitbucket account/profile under SSH Keys, label it with any title and CopyPaste
**we are using Visual Studio Community 2013 Update 4 (select the Community Version) https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
**we are not(!) using Visual Studio Community 2015 RC - to compile the code (ISO is recommend)....still need to check if Supremacy code compiles with it, so instead we might need to depend on VS2013 http://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs....for VS 2015 we read to create a new project, import Supremacy and go through all the issues
**you also need to have an account on http://bitbucket.org
**and you should have Skype installed to participate in the meetings we have

*when you attempt to clone by ssh instead of https, check the following tutorial: http://confluence.atlassian.com/display/BITBUCKET/Set+up+SSH+for+Mercurial

*here some simple text editors useful to edit stuff like xml files, just pick the one you prefer they all are great:
**http://www.sublimetext.com/
**http://www.contexteditor.org/index.php
**http://notepad-plus-plus.org/ (used by reg atm)

== SourceTree ==

*Download >> https://www.sourcetreeapp.com/?v=win (or while cloning...use the link below blue Clone Button)

*Tools: 3rd point: OPTIONS

*SSH Client Configuration:
**SSH Key: c:\....\ReginaldPutty.ppk
**SSH Client: (IMPORTANT) PuTTY/Link (not SSH !!)
**automatically start: yes

== Visual Studio ==

It's possible (and standard) to compile the game with Visual Studio. No further stuff of programs is needed, except matching Resources folder. Mention that the compiled exe is then in \Mainline\bin\Debug (or \Release).

=== Visual C++ Library ===

IMPORTANT: As Microsoft no longer provides Visual C++ Library as standard installed component ...don't forget to select or install this manually! In VS you can recognize it if \Supremacy Native is unload (sign is greyed out a little bit)

==== SupremacyNative ====

SupremacyNative is C++ coded. Sometimes there are some problems with it https://developercommunity.visualstudio.com/content/problem/312852/internal-compiler-error-in-vs158-msc1cpp-line-1518.html

=== VS2019 ===

* meanwhile we are on VS 2019 Community version https://www.visualstudio.com/downloads

=== VS2017 ===

In May 2017 we're trying to change to VS 2017 Community version https://www.visualstudio.com/downloads

*you might want to change language at TOOLS > OPTIONS > ENVIROMENT > INTERNATIONAL SETTINGS

* first make a clean !!, maybe for each single project (10 of 10)

* SOLUTION EXPLORER - right mouse click - retarget (in the middle) - select newest versions

* (this should be only needed once and should be uploaded to Repository by one guy) SupremacyClient > Set as start Project

*after cleaning maybe use REBUILD

for more see >> [[#Tools|here]]

=== VS2015 ===

since April 2016 we're using VS 2015

*Visual Studio '''Community''' 2015 RC - to compile the code (ISO is recommend) ... still need to check if Supremacy code compiles with it, so instead we might need VS2013. NEW: we try to go to VS 2015 now.
https://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs - you need the "Community" Version, currently (Apr 2016) version "Update 2"

==== VS 2015 Update 3 ====

*says it does uninstall Update 2
*needs update to 33 GB to install (only if every is selected) - seems to need some hours...

=== old VS ===

*Visual Studio Community 2013 (Community version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2012 (Express version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2008 (German) http://www.microsoft.com/de-de/download/details.aspx?id=13276

=== Tools ===

*Indent Guides https://visualstudiogallery.msdn.microsoft.com/e792686d-542b-474a-8c55-630980e72c30 Adds vertical lines at each indent level.

* Vertical tabs https://marketplace.visualstudio.com/items?itemName=VisualStudioProductTeam.ProductivityPowerPack2017

*PowerShell Tools für VS 2015

=== Tips ===
*TOOLS > OPTIONS > ENVIRONMENT > Color theme -> Black

*TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Detect when file is changed outside... -> Yes
**TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Reload modified files... -> Yes

*DEBUG > OPTIONS > PROJECTS... > BUILD AND RUN > when code=project is changed="out of date" > "Always Build" (checkbox "only build ...on Run" is marked)
**https://www.vb-paradise.de/index.php/Thread/47935-Code-bei-Klick-auf-Debugging-starten-kompilieren-wenn-er-sich-ge%C3%A4ndert-hat/

*TOOLS > OPTIONS > TEXT EDITOR > ALL LANGUAGES > Line Number (activate for all)

*DEBUG > SUPREMACY CLIENT PROPERTIES (last) > DEBUG > Start project > Command line arguments: "-aiexplore -SAVEDGAME:auto" (if you save in Supremacy manually a game with name "auto" (independent from game's "(autosave)", this manually saved game can be loaded at startup.
**"-aiexplore" isn't necessary. For more see [[Command line parameter]]
**if working for example on Cardassian UI just save Cardassian as "auto".
**when you want to change to Klingons, just retire and start Klingons. If you want to work steady on Klingons, save a Klingon's game with auto.
**if you want to start a new game steady, just go Command line arguments (see above) and change the filename to an unused one like "-SAVEDGAME:auto123"

*activate Toolbar BUILD by right mouse click on Toolbar line

* Tools -> Options -> Debugging -> Output Window -> Module Load Messages -> Off

==== Editor ====
we're using some different editors
*one option is to drag'n'drop files like xml to Visual Studio
*sometimes we use Notepad++ https://notepad-plus-plus.org/download with Extension Compare (PLUGINS > PLUGIN MANAGER > SHOW P-Manager > "Compare" ...install
*for a black style we use Sublime http://www.sublimetext.com/2

==== Screenshot ====

*reg likes Greenshot http://getgreenshot.org/
**puts an icon into task bar. There: > PREFERENCES
***PREFERENCES > GENERAL: reg uses for "Capture region" CRTL+PRNT (and no other hotkey)
***PREFERENCES > OUTPUT: define a folder at "Storage location" and a standard file type (default is *.png)
***PREFERENCES > DESTINATION: (reg's settings)
****- turn off "Select destination dymnamically"
****- open in image editor
****- copy to clipboard
**Usage:
***press Hotkey and make Screenshot
***paste immediately anywhere OR
***work on it inside Greenshot (give red circles or mark up in any colour), give numbers, obfuscate and more
***save or save as jpg or print

== Compiling ==

if you have an error with "Glyphs.xaml", than make sure you have copied \Resources MANUALLY into the output folders - this was changed in 2015. The output folder depends on compiling method "Debug" or "Release", it is
*for DEBUG _: (YourRepositoryFolder)\Mainline\bin\'''Debug\Resources''' or
*for RELEASE: (YourRepositoryFolder)\Mainline\bin\'''Release\Resources'''

it's creating:
*1> Supremacy.Scripting -> %path_repo%\bin\Debug\lib\Supremacy.Scripting.dll
*2> SupremacyCore -> %path_repo%\bin\Debug\lib\SupremacyCore.dll
*3> Supremacy.Xna -> %path_repo%\bin\Debug\lib\Supremacy.Xna.dll
*4> SupremacyClientComponents -> %path_repo%\bin\Debug\lib\SupremacyClientComponents.dll
*5> SupremacyWPF -> %path_repo%\bin\Debug\lib\SupremacyWPF.dll
*6> SupremacyService -> %path_repo%\bin\Debug\lib\SupremacyService.dll
*7> SupremacyUI -> %path_repo%\bin\Debug\lib\SupremacyUI.dll

== Visual C# ==

build in Visual Studio

<img>http://botf2.square7.ch/wiki-files/images/VS2015.jpg</img>

== SunBurn ==

SunBurn is on hold for now. Kenneth was working sometimes with SunBurn...this might be a site for this http://channel9.msdn.com/coding4fun/blog/No-need-for-sunscreen-you-want-this-SunBurn-SunBurn-v2-RTMs-including-the-free-SunBurn-Framework-Edi

*http://en.wikipedia.org/wiki/List_of_game_engines

== .Net ==

you should use latest [http://www.microsoft.com/net .Net-version] (2014: version 4.5.1)

== XNA ==

"Could not load file or assembly 'Microsoft.Xna.Framework.dll' or one of its dependencies. The specified module could not be found."

*suggestion by reg: go to \Resources\Models and rename the "Models"-folder to "Models-SetOffline" or something else (if building a ship no model is shown -as it is to most of the ships- but otherwise the game could work fine)

This suggests the problem is with your XNA installation. The game uses XNA to display the 3D ship models in the shipyard. There's no way to disable the models so XNA wouldn't be needed. So to be able to play the game, i'd advise to uninstall XNA, then install the latest version.

XNA 3.1 (this one you need in any case): http://www.microsoft.com/en-us/download/details.aspx?id=15163

XNA 4.0 Download link: http://www.microsoft.com/en-gb/download/details.aspx?id=20914

== Try ==

(for boolean)

try
{
return true;
}
catch (Exception e)
{
var errors = new System.Collections.Concurrent.ConcurrentStack<Exception>();
errors.Push(e);
return false;
}
finally
{
xxx;
}
;

== Contexts ==

*AppContext (programm running)
*GameContext.Current (Game started - so after StartScreen)
*PlayerContext.Current

== Text ==
=== en.txt ===
* XAML expample: Text="{s:StringResource EMPIRES_HEADER}"
* ResourceManager.GetString("KEY_IN-EN_TXT",parameter);

== LocalPlayer ==

*AppContext.LocalPlayer (just inside XAML-code files ??)

== Civilization ==

just the data out of Civilization.xml ... for more see [[#CivilizationManager]]

== CivilizationManager ==

CivilizationManager holds all the data like amount of credits, diplomacy, sitreps and more

*GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

== GameLog ==

GameLog.Client.GameData.DebugFormat("Civilization.cs: isBorgPlayable={0}, _throwOutRace={1}, _civType before: {2}", isBorgPlayable, _throwOutRace, _civType);

== MessageBox (Windows Style) ==

MessageBox.Show("Borg turned into Expanded", "WARNING", MessageBoxButton.OK);

== MessageDialog (Supremacy Style) ==

var result = MessageDialog.Show("Borg turned into Expanded", MessageDialogButtons.YesNo);

== SoundPlaying ==

* _soundPlayer.PlayFile("Resources/SoundFX/ChatMessage.wav");

System Requirements

2020-09-06T06:36:05Z

Reginald:

Check your installed programs: just press Win-Key+R and input "appwiz.cpl" + ENTER.

Check:
*Microsoft .NET Framework 4.6.2 http://www.microsoft.com/de-de/download/details.aspx?id=40779 - also update to latest Win10 version
*Microsoft Visual C++ 2008 Redistributable (1,7 MB) (needed !)
*Microsoft Visual C++ 2010 Redistributable (5 MB) https://support.microsoft.com/de-de/help/2977003/the-latest-supported-visual-c-downloads
*Microsoft XNA Framework (7 MB)

The currently requirements are:

*'''Microsoft .NET Framework 4.6.2 Extended ([http://en.wikipedia.org/wiki/.NET_Framework Wikipedia]) -> manual installing is necessary ->''' [http://botf2.square7.ch/wiki/index.php?title=Problem#check_your_.Net-Version Check and download here]

Summary: any usual Windows PC
*Intel Core Processor (not to old)
*512mb RAM
*[[Windows]] (tm): Windows XP up to Windows 8.1 (if you have problems, just see [[Problem#Windows problem]])
*DirectX 9-compatible video card with Pixel Shader 2.0+ and Vertex Shader 1.1+ support
*Desktop resolution of at least 1024x768 (1280x768 or higher is strongly recommended)
*[[DirectX]] 9 or greater
----
Due to other programs also use the next parts the game requires (e.g. Zone Alarm free: Microsoft .NET Redistributable, Microsoft VC++ Redistributable (x86) http://www.windowsuninstaller.org/forums/viewtopic.php?f=8&t=743#p1158) some might be already installed on your PC. This might be the reason why some persons can ran Supremacy without great installing all the requirements, and others have to install all the stuff.
----
Many reports are on missing XNA. Just mention this requirement:
*Microsoft XNA Framework v3.1 Redistributable http://www.microsoft.com/en-us/download/details.aspx?id=15163
Without it, the game isn't able to load the 3d models that you can see in the shipyard, resulting in crashes.

----

If BotF2 still not runs then...

Lloyd James wrote: To run BotF2, you need ALL of the following installed:
*Microsoft .NET Framework ''4.5.1'' (note: you want the full framework, not the "Client Profile"; after it's installed, you should see both the "Client Profile" and "Extended Profile" listed in your control panel. Also note that the latest version of .Net is 4.5, and future game versions *might* need the more recent versions) http://www.microsoft.com/de-de/download/details.aspx?id=40779
*Microsoft DirectX Runtime
*Microsoft XNA Framework v3.1 Redistributable http://www.microsoft.com/en-us/download/details.aspx?id=15163, v4.0 might also work http://www.microsoft.com/en-us/download/details.aspx?id=20914
*Microsoft Visual C++ 2008 Redistributable (1,7 MB) (needed !)
*Microsoft Visual C++ 2010 Redistributable (5 MB)

All of these can be found via Google. Simply copy-and-paste them and select the first link that appears.

Source Code

2020-09-05T15:13:12Z

Reginald: /* VS2019 */

== Source Code ==

http://guganeshan.com/blog/setting-up-git-and-tortoisegit-with-bitbucket-step-by-step.html

=== official ===

* code is now at https://github.com/BotF2/BotF2.git

*last source code https://bitbucket.org/mstrobel/supremacy/overview (it's in C#, also named CSharp. [[#Visual Studio]] is used for coding.)
**Mike's Post: build in [http://www.microsoft.com/downloads/dlx/en-us/ThankYou.aspx?FamilyID=75568AA6-8107-475D-948A-EF22627E57A5 VS2010] with .NET 4.0. You may need the [http://en.csharp-online.net/Download_Free_Microsoft_Visual_CSharp_.NET#Download_Microsoft_Visual_Studio_Async_Community_Technology_Preview_.28CTP.29 C# Async CTP]. http://bote2.square7.ch/forum/viewtopic.php?p=70790#p70790
**http://bote2.square7.ch/forum/viewtopic.php?p=70781#p70781
*** Supremacy.Game.GameEngine is where you'll find most of the game logic. That's where most of the turn processing happens.
*** The SupremacyCore project is where you'll find the foundation of the game.
*** SupremacyService is just the game server (all the important bits it interacts with are in SupremacyCore).
*** SupremacyClientComponents is UI infrastructure.
*** SupremacyUI and SupremacyWPF are older UI infrastructure stuff, much of which has been phased out and replaced by newer and better stuff in SupremacyClientComponents. The most interesting stuff in SupremacyUI is GalaxyGridPanel, which draws the galactic map. It also has the spinning planet views.
*** Supremacy.Xna is where the XNA/3D stuff is located--it's not used heavily yet, but it has some effects for the invasion screen, a newer star renderer, a 3D spinning ship renderer, etc.
*** Supremacy.Scripting is an expression language parser/compiler.
*** SupremacyClient is the main graphical client and has most of the game screen implementations.

*old source code can be taken from here: http://supremacy.codeplex.com/ (last upload from MStrobel at 03.01.2011)

==== ClientContext vs AppContext ====

taken from https://bitbucket.org/kflanagan/supremacydev/commits/0d562ce676425cd5da19cfdbcf1b6c18c7d0d135

*IClientContext is used by SupremacyCore to interface clients participating on a game, both local and over network. The IClientContext further includes an interface to IGameContext which gives access to the game data itself inside the '''SupremacyClient app'''
*However there should be an option to also include local properties not known to the Core, which is why this is done alternatively another context would have to be introduced for local data, but then still all the client code would have to be updated to make use of it

==== .XAML files ====

In Windows Presentation Foundation (WPF), a windows app framework used by Supremacy, XAML forms a user interface markup language to define UI elements, data binding, events, and other features.

Info resources:

*MS Article: [https://msdn.microsoft.com/en-us/library/ms745683(v=vs.110).aspx XAML Styling and Templating]

*Youtube video: [https://www.youtube.com/watch?v=0qE5hyuU9hE Introduction to XAML] (26min)

== Bitbucket ==

*https://confluence.atlassian.com/display/BITBUCKET/Maintaining+a+Mercurial+Repository

== Changes ==

see [[ChangeLog|here]] or https://bitbucket.org/mstrobel/supremacy/commits/branch/default

=== 2016 ===

==== XAML ====

*January 2016 [Planned]: Hope to get Major Race specific UI build through use of generic XAML files.
* ClientApp.xaml.cs has the code to direct UI to race specific folders of xaml files in SupremacyClient/themes/{0}

Looking at SystemScreen.xaml, Global.xaml and ClientModules.cs in Themes/SupremacyClient
See also generic.xaml in SupremacyClientComponents/Themes/InfoCard Theme.xaml Default.xaml Icons.xaml ClientApp.xaml.cs SystemScreen.xaml

1/17/16: Found that Mikes code in ClientApp.xaml.cs will already select for Major race. Need new folders for each major race in SupremacyClient/themes/(major race), edit paths to Resources in the .xaml files found in each races set of .xaml files. File names in SupremacyClient/themes/(major race) are not unique but content in Resources is. Now you can edit files in Resources for unique UI.

2/13/16:

<Polygon
Points="300,200 400,125 400,275 300,200"
Stroke="Purple"
StrokeThickness="2">
<Polygon.Fill>
<SolidColorBrush Color="Blue" Opacity="0.4"/>
</Polygon.Fill>
</Polygon>

Makes a left pointing triangle, purple outline and blue body

=== 2015 ===

*'''Animation.cs''' (animation of opening screen): This is where we can set the number of images, frames, and the rate they play at, currently all images in 30 seconds. We may want that to run faster. The images you will make for the ship de-cloaking will be located in Resources / Images / Animation.
* \supremacyclient\'''ClientModule.cs''':
**Found a place to add the right mouse click instructions for the Panel Access Menu. A thing called the statusWindow held the text "loading" while you wait for a game to load. Added the information there for new players

*FMOD is partly replace by AudioEngine.cs and others - just find it out

=== 2014 ===

== some code ==

for Theme and UI see >> '''[[Theme]]'''

=== miscellaneous ===

*Mainline\SupremacyClient\GameContextMenu.cs

*\Mainline\SupremacyUI\SystemProductionPanel.cs

*\Mainline\SupremacyCore\Orbitals\FleetOrders.cs -> all items inside a sector

*Mainline\SupremacyClient\GameContextMenu.cs (Access Popup Menu - or use F1 to F5)

*\Mainline\SupremacyClientComponents\Controls\InfoCard\InfoCard.cs (-> Tooltips ??)
**\Mainline\SupremacyClient\themes\Federation\InfoCard.xaml -> <Setter Property="Width" Value="500" /> (BEFORE: 250)

*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyPlanetaryBuildQueueView.xaml - Colonies Screen Content

*\Mainline\SupremacyCore\Universe\Colony.cs
*\Mainline\SupremacyClient\Views\ColonyScreen\ColonyStructureListView.xaml
**Size of this area: 720 x 240

*\Mainline\SupremacyClient\Views\GalaxyScreen\TaskForceListView.xaml

=== Version Number ===

Look for version number control in AssemblyInfo.cs

your hard disk code folder BotF2\SupremacyClient\Properties\AssemblyInfo.cs

---
example code: (put in your current star date)

*[assembly: AssemblyVersion("2018.11.20.0")]
*[assembly: AssemblyFileVersion("2018.11.20.0")]

=== Ships ===

*\Fleets.cs
*\FleetOrder.cs (without a "s" - beware of it)
*\FleetOrders.cs

*\mainline\supremacyclientcomponents\views\galaxyscreen\galaxyscreenpresenter.cs TaskForcesList

==== Building Ships ====

*Cancelling -> Breakpoint at Line 185 at OnShipyardBuildProjectsChanged() \Mainline\SupremacyClientComponents\Views\ColonyScreen\ColonyScreenPresentationModel.cs

=== Sounds ===

*\Mainline\SupremacyClient\AudioEngine.cs (for Music), for Sounds >> SoundPlayerAction is used (search for \Resources\UI\Federation\SoundsButtonClick.wav)
*and in \Mainline\SupremacyClientComponents\Views\SystemAssaultScreen\SystemAssaultScreenViewModel.cs -> Uri is used (e.g. CombatLaser.wav)

=== Galaxy Generator ===

*\Mainline\SupremacyCore\Universe\GalaxyGenerator.cs

=== Values ===
*CivID: 0 = Federation...

=== TurnPhase ===

WaitOnPlayers = 0,
PreTurnOperations,
ResetObjects,
FleetMovement,
Combat,
PopulationGrowth,
PersonnelTraining,
Research,
Scrapping,
Maintenance,
ShipProduction,
Production,
Trade,
Morale,
MapUpdates,
PostTurnOperations,
SendUpdates,
Diplomacy,
WaitOnAIPlayers

=== older list ===

{|class="wikitable sortable"
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |where
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Folder
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |File
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Function
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Date
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Description
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom1
! bgcolor="#dadada" style="border:4px solid #999999;padding:0.2em;padding-top:0.2em;" |Custom2

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameContext.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
initialising game
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|
Raw Materials, Deuterium, Dilithium is collected cross over all colonies and used by all colonies
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Game
|style=text-align:center|GameEngine.cs
|style=text-align:center|DoShipProduction(GameContext game)
|style=text-align:center|
|style=text-align:left|

|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Combat
|style=text-align:center|InvasionArena.cs
|style=text-align:center|
|style=text-align:center|
|style=text-align:left|
SystemAssault
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Orbital
|style=text-align:center|Shipyard.cs
|style=text-align:center|GetBuildOutput(int slot)
|style=text-align:center| [https://bitbucket.org/Bloodwurm/BotF2dev/commits/1aafc8f6e47e9e3b9c20de79f2d02f197c023d63 2014-01-15]
|style=text-align:left|
just selects output (active?) and bonus (BonusType.PercentShipBuilding), since 2014-01-15 also case PopulationRatio or IndustryRatio
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|GetProductionOutput(ProductionCategory category)
|style=text-align:center|
|style=text-align:left|
see last line, too !
*Food: minimum 10
*Research:
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*Industry: '''minimum 10 !'''
float moraleMod = _morale.CurrentValue / (0.5f * MoraleHelper.MaxValue);
baseOutput = (int)(moraleMod * baseOutput);
*last line: return ((int)(baseOutput + (baseOutput * modifier.Efficiency)) + modifier.Bonus);
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasFoodBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasFoodBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-Core
|style=text-align:center|Universe
|style=text-align:center|Colony.cs
|style=text-align:center|planet.HasEnergyBonus (OutputModifier)
|style=text-align:center|
|style=text-align:left|
if (planet.HasEnergyBonus)
modifier.Efficiency += 0.15f;
|style=text-align:left|
|style=text-align:left|

|-
|style=text-align:left|S-ClientComp
|style=text-align:center|Views\GalaxyScreen
|style=text-align:center|GalaxyScreenView.cs
|style=text-align:center|GalaxyScreenView()
|style=text-align:center|
|style=text-align:left|GalaxyView Hotkeys Definition (see [[Hotkey]]s)
|style=text-align:left|
|style=text-align:left|

|}

== Botf2-coding-practice ==

*http://star-trek-supremacy.proboards.com/thread/349/botf2-coding-practice (intern)

*prepare:
**...we are using SourceTree, provided by bitbucket (another option: TortoiseHg with Mercurial - to access the supremacy code repository http://tortoisehg.bitbucket.org/)
**PuTTYgen - to generate a ssh key to allow using ssh protocol instead of slow https http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
***or use C:\Program Files (x86)\Atlassian\SourceTree\tools\putty..puttygen.exe....generate a key (using a phrase is not neccessary)
***copy the public key (4-5 lines) into your bitbucket account/profile under SSH Keys, label it with any title and CopyPaste
**we are using Visual Studio Community 2013 Update 4 (select the Community Version) https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
**we are not(!) using Visual Studio Community 2015 RC - to compile the code (ISO is recommend)....still need to check if Supremacy code compiles with it, so instead we might need to depend on VS2013 http://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs....for VS 2015 we read to create a new project, import Supremacy and go through all the issues
**you also need to have an account on http://bitbucket.org
**and you should have Skype installed to participate in the meetings we have

*when you attempt to clone by ssh instead of https, check the following tutorial: http://confluence.atlassian.com/display/BITBUCKET/Set+up+SSH+for+Mercurial

*here some simple text editors useful to edit stuff like xml files, just pick the one you prefer they all are great:
**http://www.sublimetext.com/
**http://www.contexteditor.org/index.php
**http://notepad-plus-plus.org/ (used by reg atm)

== SourceTree ==

*Download >> https://www.sourcetreeapp.com/?v=win (or while cloning...use the link below blue Clone Button)

*Tools: 3rd point: OPTIONS

*SSH Client Configuration:
**SSH Key: c:\....\ReginaldPutty.ppk
**SSH Client: (IMPORTANT) PuTTY/Link (not SSH !!)
**automatically start: yes

== Visual Studio ==

It's possible (and standard) to compile the game with Visual Studio. No further stuff of programs is needed, except matching Resources folder. Mention that the compiled exe is then in \Mainline\bin\Debug (or \Release).

=== Visual C++ Library ===

IMPORTANT: As Microsoft no longer provides Visual C++ Library as standard installed component ...don't forget to select or install this manually! In VS you can recognize it if \Supremacy Native is unload (sign is greyed out a little bit)

==== SupremacyNative ====

SupremacyNative is C++ coded. Sometimes there are some problems with it https://developercommunity.visualstudio.com/content/problem/312852/internal-compiler-error-in-vs158-msc1cpp-line-1518.html

=== VS2019 ===

* meanwhile we are on VS 2019 Community version https://www.visualstudio.com/downloads

=== VS2017 ===

In May 2017 we're trying to change to VS 2017 Community version https://www.visualstudio.com/downloads

*you might want to change language at TOOLS > OPTIONS > ENVIROMENT > INTERNATIONAL SETTINGS

* first make a clean !!, maybe for each single project (10 of 10)

* SOLUTION EXPLORER - right mouse click - retarget (in the middle) - select newest versions

* (this should be only needed once and should be uploaded to Repository by one guy) SupremacyClient > Set as start Project

*after cleaning maybe use REBUILD

for more see >> [[#Tools|here]]

=== VS2015 ===

since April 2016 we're using VS 2015

*Visual Studio '''Community''' 2015 RC - to compile the code (ISO is recommend) ... still need to check if Supremacy code compiles with it, so instead we might need VS2013. NEW: we try to go to VS 2015 now.
https://www.visualstudio.com/downloads/visual-studio-2015-downloads-vs - you need the "Community" Version, currently (Apr 2016) version "Update 2"

==== VS 2015 Update 3 ====

*says it does uninstall Update 2
*needs update to 33 GB to install (only if every is selected) - seems to need some hours...

=== old VS ===

*Visual Studio Community 2013 (Community version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2012 (Express version is free) http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-desktop
*Visual Studio Express 2008 (German) http://www.microsoft.com/de-de/download/details.aspx?id=13276

=== Tools ===

*Indent Guides https://visualstudiogallery.msdn.microsoft.com/e792686d-542b-474a-8c55-630980e72c30 Adds vertical lines at each indent level.

* Vertical tabs https://marketplace.visualstudio.com/items?itemName=VisualStudioProductTeam.ProductivityPowerPack2017

*PowerShell Tools für VS 2015

=== Tips ===
*TOOLS > OPTIONS > ENVIRONMENT > Color theme -> Black

*TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Detect when file is changed outside... -> Yes
**TOOLS > OPTIONS > ENVIRONMENT > DOCUMENTS > Reload modified files... -> Yes

*DEBUG > OPTIONS > PROJECTS... > BUILD AND RUN > when code=project is changed="out of date" > "Always Build" (checkbox "only build ...on Run" is marked)
**https://www.vb-paradise.de/index.php/Thread/47935-Code-bei-Klick-auf-Debugging-starten-kompilieren-wenn-er-sich-ge%C3%A4ndert-hat/

*TOOLS > OPTIONS > TEXT EDITOR > ALL LANGUAGES > Line Number (activate for all)

*DEBUG > SUPREMACY CLIENT PROPERTIES (last) > DEBUG > Start project > Command line arguments: "-aiexplore -SAVEDGAME:auto" (if you save in Supremacy manually a game with name "auto" (independent from game's "(autosave)", this manually saved game can be loaded at startup.
**"-aiexplore" isn't necessary. For more see [[Command line parameter]]
**if working for example on Cardassian UI just save Cardassian as "auto".
**when you want to change to Klingons, just retire and start Klingons. If you want to work steady on Klingons, save a Klingon's game with auto.
**if you want to start a new game steady, just go Command line arguments (see above) and change the filename to an unused one like "-SAVEDGAME:auto123"

*activate Toolbar BUILD by right mouse click on Toolbar line

* Tools -> Options -> Debugging -> Output Window -> Module Load Messages -> Off

==== Editor ====
we're using some different editors
*one option is to drag'n'drop files like xml to Visual Studio
*sometimes we use Notepad++ https://notepad-plus-plus.org/download with Extension Compare (PLUGINS > PLUGIN MANAGER > SHOW P-Manager > "Compare" ...install
*for a black style we use Sublime http://www.sublimetext.com/2

==== Screenshot ====

*reg likes Greenshot http://getgreenshot.org/
**puts an icon into task bar. There: > PREFERENCES
***PREFERENCES > GENERAL: reg uses for "Capture region" CRTL+PRNT (and no other hotkey)
***PREFERENCES > OUTPUT: define a folder at "Storage location" and a standard file type (default is *.png)
***PREFERENCES > DESTINATION: (reg's settings)
****- turn off "Select destination dymnamically"
****- open in image editor
****- copy to clipboard
**Usage:
***press Hotkey and make Screenshot
***paste immediately anywhere OR
***work on it inside Greenshot (give red circles or mark up in any colour), give numbers, obfuscate and more
***save or save as jpg or print

== Compiling ==

if you have an error with "Glyphs.xaml", than make sure you have copied \Resources MANUALLY into the output folders - this was changed in 2015. The output folder depends on compiling method "Debug" or "Release", it is
*for DEBUG _: (YourRepositoryFolder)\Mainline\bin\'''Debug\Resources''' or
*for RELEASE: (YourRepositoryFolder)\Mainline\bin\'''Release\Resources'''

it's creating:
*1> Supremacy.Scripting -> %path_repo%\bin\Debug\lib\Supremacy.Scripting.dll
*2> SupremacyCore -> %path_repo%\bin\Debug\lib\SupremacyCore.dll
*3> Supremacy.Xna -> %path_repo%\bin\Debug\lib\Supremacy.Xna.dll
*4> SupremacyClientComponents -> %path_repo%\bin\Debug\lib\SupremacyClientComponents.dll
*5> SupremacyWPF -> %path_repo%\bin\Debug\lib\SupremacyWPF.dll
*6> SupremacyService -> %path_repo%\bin\Debug\lib\SupremacyService.dll
*7> SupremacyUI -> %path_repo%\bin\Debug\lib\SupremacyUI.dll

== Visual C# ==

build in Visual Studio

<img>http://botf2.square7.ch/wiki-files/images/VS2015.jpg</img>

== SunBurn ==

SunBurn is on hold for now. Kenneth was working sometimes with SunBurn...this might be a site for this http://channel9.msdn.com/coding4fun/blog/No-need-for-sunscreen-you-want-this-SunBurn-SunBurn-v2-RTMs-including-the-free-SunBurn-Framework-Edi

*http://en.wikipedia.org/wiki/List_of_game_engines

== .Net ==

you should use latest [http://www.microsoft.com/net .Net-version] (2014: version 4.5.1)

== XNA ==

"Could not load file or assembly 'Microsoft.Xna.Framework.dll' or one of its dependencies. The specified module could not be found."

*suggestion by reg: go to \Resources\Models and rename the "Models"-folder to "Models-SetOffline" or something else (if building a ship no model is shown -as it is to most of the ships- but otherwise the game could work fine)

This suggests the problem is with your XNA installation. The game uses XNA to display the 3D ship models in the shipyard. There's no way to disable the models so XNA wouldn't be needed. So to be able to play the game, i'd advise to uninstall XNA, then install the latest version.

XNA 3.1 (this one you need in any case): http://www.microsoft.com/en-us/download/details.aspx?id=15163

XNA 4.0 Download link: http://www.microsoft.com/en-gb/download/details.aspx?id=20914

== Try ==

(for boolean)

try
{
return true;
}
catch (Exception e)
{
var errors = new System.Collections.Concurrent.ConcurrentStack<Exception>();
errors.Push(e);
return false;
}
finally
{
xxx;
}
;

== Contexts ==

*AppContext (programm running)
*GameContext.Current (Game started - so after StartScreen)
*PlayerContext.Current

== LocalPlayer ==

*AppContext.LocalPlayer (just inside XAML-code files ??)

== Civilization ==

just the data out of Civilization.xml ... for more see [[#CivilizationManager]]

== CivilizationManager ==

CivilizationManager holds all the data like amount of credits, diplomacy, sitreps and more

*GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

GameContext.Current.CivilizationManagers[LocalPlayer.EmpireID]

== GameLog ==

GameLog.Client.GameData.DebugFormat("Civilization.cs: isBorgPlayable={0}, _throwOutRace={1}, _civType before: {2}", isBorgPlayable, _throwOutRace, _civType);

== MessageBox (Windows Style) ==

MessageBox.Show("Borg turned into Expanded", "WARNING", MessageBoxButton.OK);

== MessageDialog (Supremacy Style) ==

var result = MessageDialog.Show("Borg turned into Expanded", MessageDialogButtons.YesNo);

== SoundPlaying ==

* _soundPlayer.PlayFile("Resources/SoundFX/ChatMessage.wav");