Skip to content

Commit

Permalink
Fix a couple of warnings.
Browse files Browse the repository at this point in the history
Update BWAPI overview in README.
Update Doxyfile macros.

git-svn-id: https://bwapi.googlecode.com/svn/trunk@4455 273ecf2c-f24b-0410-b6a7-e9298bb4873f
  • Loading branch information
heinermann committed Aug 28, 2013
1 parent 861c06a commit 4dd8f93
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 13 deletions.
11 changes: 5 additions & 6 deletions Release_Binary/README
Expand Up @@ -12,12 +12,11 @@ IRC Channel Freenode #BWAPI

1. Introduction to BWAPI
------------------------
The Brood War Application Programming Interface (BWAPI) is a free and open
source C++ framework for creating AI modules for Starcraft: Broodwar. Using
BWAPI, programmers can retrieve information on players and individual units
in Starcraft as well as issue a wide variety of commands to units, opening
the doors for custom AIs with new micro and macro algorithms.

The Brood War Application Programming Interface (BWAPI) is a free and open
source C++ framework that is used to interact with the popular Real Time Strategy
(RTS) game Starcraft: Broodwar. Using BWAPI, students, researchers, and hobbyists
can create Artificial Intelligence (AI) agents that play the game.

The installer contains all the necessary include files, libs, and dlls
required to compile and run an AI module and also comes with four projects
to help get you started in AI development with BWAPI:
Expand Down
1 change: 0 additions & 1 deletion bwapi/BWAPILIB/BWAPILIB.vcxproj
Expand Up @@ -134,7 +134,6 @@ COPY /y "$(OutDir)$(TargetName)$(TargetExt)" "..\lib\BWAPId.lib"</Command>
<ClCompile Include="Source\TechType.cpp" />
<ClCompile Include="Source\Unit.cpp" />
<ClCompile Include="Source\Unitset.cpp" />
<ClCompile Include="Source\Vectorset.cpp" />
<ClCompile Include="UnitCommand.cpp" />
<ClCompile Include="Source\UnitCommandType.cpp" />
<ClCompile Include="Source\UnitSizeType.cpp" />
Expand Down
3 changes: 0 additions & 3 deletions bwapi/BWAPILIB/BWAPILIB.vcxproj.filters
Expand Up @@ -58,9 +58,6 @@
<ClCompile Include="Source\Unitset.cpp">
<Filter>Containers\Source Files</Filter>
</ClCompile>
<ClCompile Include="Source\Vectorset.cpp">
<Filter>Containers\Source Files</Filter>
</ClCompile>
<ClCompile Include="Source\Color.cpp">
<Filter>Types\Source Files</Filter>
</ClCompile>
Expand Down
2 changes: 1 addition & 1 deletion bwapi/BWAPILIB/Source/Game.cpp
Expand Up @@ -395,7 +395,7 @@ namespace BWAPI
reserve.restoreIfInvalid(__FUNCTION__);
}

void ReservePlacement(PlacementReserve &reserve, UnitType type, TilePosition desiredPosition, bool creep)
void ReservePlacement(PlacementReserve &reserve, UnitType type, TilePosition desiredPosition, bool /*creep*/)
{
// Reset the array
reserve.reset();
Expand Down
47 changes: 45 additions & 2 deletions bwapi/include/Doxyfile
Expand Up @@ -32,7 +32,7 @@ PROJECT_NAME = BWAPI
# This could be handy for archiving the generated documentation or
# if some version control system is used.

PROJECT_NUMBER = 4.0.0
PROJECT_NUMBER = 4.0.1

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer
Expand Down Expand Up @@ -286,7 +286,50 @@ ALIASES = "Dropships=@ref UnitTypes::Terran_Dropship \"Dropships\
"Ghost=@ref UnitTypes::Terran_Ghost \"Ghost\"" \
"minerals=@ref UnitTypes::Resource_Mineral_Field \"Mineral Fields\"" \
"geysers=@ref UnitTypes::Resource_Vespene_Geyser \"Vespene Geysers\"" \
"critters=@ref UnitTypes::Critter_Bengalaas \"Critters\""
"critters=@ref UnitTypes::Critter_Bengalaas \"Critters\"" \
"mines=@ref UnitTypes::Terran_Vulture_Spider_Mine \"Spider Mines\"" \
"matrix=@ref TechTypes::Defensive_Matrix \"Defensive Matrix\"" \
"ensnare=@ref TechTypes::Ensnare \"Ensnare\"" \
"irradiate=@ref TechTypes::Irradiate \"Irradiate\"" \
"lockdown=@ref TechTypes::Lockdown \"Lockdown\"" \
"maelstrom=@ref TechTypes::Maelstrom \"Maelstrom\"" \
"plague=@ref TechTypes::Plague \"Plague\"" \
"stasis=@ref TechTypes::Stasis_Field \"Stasis Field\"" \
"stim=@ref TechTypes::Stim_Packs \"Stim Packs\"" \
"worker=worker (@ref UnitTypes::Terran_SCV \"SCV\", @ref UnitTypes::Protoss_Probe \"Probe\", @ref UnitTypes::Zerg_Drone \"Drone\")" \
"Interceptor=@ref UnitTypes::Protoss_Interceptor \"Interceptor\"" \
"cloaked=@ref TechTypes::Cloaking_Field \"cloaked\"" \
"locked=@ref TechTypes::Lockdown \"locked\"" \
"Maelstrommed=@ref TechTypes::Maelstrom \"maelstrommed\"" \
"plagued=@ref TechTypes::Plague \"plagued\"" \
"defiler=@ref UnitTypes::Zerg_Defiler \"Defiler\"" \
"repair=@ref Orders::Repair \"repair\"" \
"sieged=@ref TechTypes::Tank_Siege_Mode \"sieged\"" \
"Dark_Swarm=@ref TechTypes::Dark_Swarm \"Dark Swarm\"" \
"Disruption_Web=@ref TechTypes::Disruption_Web \"Disruption Web\"" \
"Flag_Beacon=@ref UnitTypes::Special_Zerg_Flag_Beacon \"Flag Beacon\"" \
"Dark_Archon=@ref UnitTypes::Protoss_Dark_Archon \"Dark Archon\"" \
"Vulture=@ref UnitTypes::Terran_Vulture \"Vulture\"" \
"hallucination=@ref TechTypes::Hallucination \"Hallucination\"" \
"broodling=@ref TechTypes::Spawn_Broodlings \"broodling\"" \
"swarm=@ref TechTypes::Dark_Swarm \"Dark Swarm\"" \
"dweb=@ref TechTypes::Disruption_Web \"Disruption Web\"" \
"scanner=@ref TechTypes::Scanner_Sweep \"Scanner Sweep\"" \
"Silos=@ref UnitTypes::Terran_Nuclear_Silo \"Nuclear Silos\"" \
"mineral_field=@ref UnitTypes::Resource_Mineral_Field \"Mineral Field\"" \
"parasite=@ref TechTypes::Parasite \"Parasite\"" \
"SCVs=@ref UnitTypes::Terran_SCV \"SCVs\"" \
"Siege_Tank=@ref UnitTypes::Terran_Siege_Tank_Tank_Mode \"Siege Tank\"" \
"Siege_Tanks=@ref UnitTypes::Terran_Siege_Tank_Tank_Mode \"Siege Tanks\"" \
"Arbiter=@ref UnitTypes::Protoss_Arbiter \"Arbiter\"" \
"probe=@ref UnitTypes::Protoss_Probe \"Probe\"" \
"drone=@ref UnitTypes::Zerg_Drone \"Drone\"" \
"assimilator=@ref UnitTypes::Protoss_Assimilator \"Assimilator\"" \
"extractor=@ref UnitTypes::Zerg_Extractor \"Extractor\"" \
"refinery=@ref UnitTypes::Terran_Refinery \"Refinery\"" \
"geyser=@ref UnitTypes::Resource_Vespene_Geyser \"Vespene Geyser\"" \
"Stim_Packs=@ref TechTypes::Stim_Packs \"Stim Packs\"" \
"Stasis=@ref TechTypes::Stasis_Field \"Stasis Field\""

# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding
Expand Down

0 comments on commit 4dd8f93

Please sign in to comment.