Fixup for public release, add readme

ErikMcClure · Feb 8, 2018 · 25ad607 · 25ad607
1 parent b075d0d
commit 25ad607
Show file tree

Hide file tree

Showing 46 changed files with 118 additions and 46 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,4 @@
+# Magnesium Changelog
+
+## 0.1.0
+- Initial release
diff --git a/Magnesium/Magnesium.rc b/Magnesium/Magnesium.rc
diff --git a/Magnesium/SCML.h b/Magnesium/SCML.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __SCML_H__MG__

diff --git a/Magnesium/mgBox2D.cpp b/Magnesium/mgBox2D.cpp
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #include "mgBox2D.h"

diff --git a/Magnesium/mgComponent.cpp b/Magnesium/mgComponent.cpp
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #include "mgComponent.h"

diff --git a/Magnesium/mgConsole.cpp b/Magnesium/mgConsole.cpp
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 
 #include "mgConsole.h"
 #include "feathergui/fgElement.h"

diff --git a/Magnesium/mgControlMap.cpp b/Magnesium/mgControlMap.cpp
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #include "mgControlMap.h"

diff --git a/Magnesium/mgEngine.cpp b/Magnesium/mgEngine.cpp
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #include "mgEngine.h"

diff --git a/Magnesium/mgEntity.cpp b/Magnesium/mgEntity.cpp
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #include "mgComponent.h"

diff --git a/Magnesium/mgJoinPSB2.cpp b/Magnesium/mgJoinPSB2.cpp
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #include "mgJoinPSB2.h"

diff --git a/Magnesium/mgLogic.cpp b/Magnesium/mgLogic.cpp
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #include "mgLogic.h"

diff --git a/Magnesium/mgLua.cpp b/Magnesium/mgLua.cpp
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 
 #include "mgLua.h"
 #include "mgEngine.h"

diff --git a/Magnesium/mgPlaneshader.cpp b/Magnesium/mgPlaneshader.cpp
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #include "mgPlaneshader.h"

diff --git a/Magnesium/mgRefCounter.cpp b/Magnesium/mgRefCounter.cpp
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #include "mgRefCounter.h"

diff --git a/Magnesium/mgSystem.cpp b/Magnesium/mgSystem.cpp
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #include "mgSystemManager.h"

diff --git a/Magnesium/mgSystemManager.cpp b/Magnesium/mgSystemManager.cpp
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #include "mgSystemManager.h"

diff --git a/Magnesium/mgTinyOAL.cpp b/Magnesium/mgTinyOAL.cpp
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #include "mgTinyOAL.h"

diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# Magnesium
+
+Magnesium is a modular, Component Entity System based game engine you can use with any libraries you build wrappers for. It comes with support for [PlaneShader](https://github.com/Black-Sphere-Studios/planeshader), [Box2D](https://github.com/Black-Sphere-Studios/Box2D), [LuaJIT](http://luajit.org/), and [TinyOAL](https://github.com/Black-Sphere-Studios/tinyoal).
+
+## Compiling
+
+Because Magnesium has so many dependencies, a [vcpkg port](https://github.com/Black-Sphere-Studios/vcpkg/tree/master/ports/magnesium) is provided to automatically acquire and build all necessary components. Simply clone the [Black Sphere Studios vcpkg fork](https://github.com/Black-Sphere-Studios/vcpkg) (or merge its changes into your own vcpkg fork), run `.\bootstrap-vcpkg.bat` and then `.\vcpkg.exe install magnesium:x64-windows` (or `magnesium:x86-windows` for the 32-bit versions). Magnesium will then be ready to be used by any `vcpkg` enabled Visual Studio game project. For more information on vcpkg, [check it's readme](https://github.com/Black-Sphere-Studios/vcpkg/blob/master/README.md).
+
+If you would like to build and test the examples, you will need to [download the SDK](https://github.com/Black-Sphere-Studios/magnesium/releases) that has the example media files. You can either install the vcpkg version of magnesium and let the Visual Studio project override it, or you can install only magnesium's dependencies: `.\vcpkg.exe install bss-util:x64-windows, planeshader:x64-windows, tinyoal:x64-windows, box2d-bss:x64-windows, luajit:x64-windows, enet:x64-windows`. Once these dependencies are installed, the SDK project file will automatically link to them, provided you've enabled [vcpkg Visual Studio integration](https://github.com/Microsoft/vcpkg/blob/master/README.md#quick-start).
+
+©2018 Erik McClure
diff --git a/examples/LD34/LD34.rc b/examples/LD34/LD34.rc
diff --git a/examples/LD34/LD34.vcxproj b/examples/LD34/LD34.vcxproj
@@ -106,7 +106,7 @@
       <SubSystem>Windows</SubSystem>
       <GenerateDebugInformation>true</GenerateDebugInformation>
       <AdditionalLibraryDirectories>../../lib</AdditionalLibraryDirectories>
-      <AdditionalDependencies>magnesium32_d.lib;bss-util32_d.lib;planeshader32_d.lib;tinyoal32_d.lib;feathergui32_d.lib;Box2D.lib;%(AdditionalDependencies)</AdditionalDependencies>
+      <AdditionalDependencies>magnesium32_d.lib;bss-util32_d.lib;planeshader32_d.lib;tinyoal32_d.lib;feathergui32_d.lib;Box2D.lib;lua51.lib;%(AdditionalDependencies)</AdditionalDependencies>
     </Link>
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
@@ -150,7 +150,7 @@
       <OptimizeReferences>true</OptimizeReferences>
       <GenerateDebugInformation>true</GenerateDebugInformation>
       <AdditionalLibraryDirectories>../../lib</AdditionalLibraryDirectories>
-      <AdditionalDependencies>magnesium32.lib;bss-util32.lib;planeshader32.lib;tinyoal32.lib;feathergui32.lib;Box2D.lib;%(AdditionalDependencies)</AdditionalDependencies>
+      <AdditionalDependencies>magnesium32.lib;bss-util32.lib;planeshader32.lib;tinyoal32.lib;feathergui32.lib;Box2D.lib;lua51.lib;%(AdditionalDependencies)</AdditionalDependencies>
     </Link>
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
@@ -183,10 +183,10 @@
     <ClCompile Include="main.cpp" />
   </ItemGroup>
   <ItemGroup>
-    <ResourceCompile Include="LD34.rc" />
+    <ClInclude Include="ld34.h" />
   </ItemGroup>
   <ItemGroup>
-    <ClInclude Include="ld34.h" />
+    <ResourceCompile Include="..\blank.rc" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">

diff --git a/examples/LD34/LD34.vcxproj.filters b/examples/LD34/LD34.vcxproj.filters
@@ -19,14 +19,14 @@
       <Filter>Source Files</Filter>
     </ClCompile>
   </ItemGroup>
-  <ItemGroup>
-    <ResourceCompile Include="LD34.rc">
-      <Filter>Resource Files</Filter>
-    </ResourceCompile>
-  </ItemGroup>
   <ItemGroup>
     <ClInclude Include="ld34.h">
       <Filter>Header Files</Filter>
     </ClInclude>
   </ItemGroup>
+  <ItemGroup>
+    <ResourceCompile Include="..\blank.rc">
+      <Filter>Resource Files</Filter>
+    </ResourceCompile>
+  </ItemGroup>
 </Project>
diff --git a/examples/LD34/ld34.h b/examples/LD34/ld34.h
@@ -1,4 +1,4 @@
-// Copyright ©2016 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __DEC_H__LD__

diff --git a/examples/LD34/main.cpp b/examples/LD34/main.cpp
@@ -1,6 +1,7 @@
 /* LD34
 *
-* Copyright ©2016 Black Sphere Studios
+* Copyright ©2018 Black Sphere Studios
+* For conditions of distribution and use, see copyright notice in Magnesium.h
 */
 
 #include "Magnesium.h"

diff --git a/examples/Testbed/Testbed.vcxproj b/examples/Testbed/Testbed.vcxproj
@@ -342,6 +342,9 @@
   <ItemGroup>
     <ClCompile Include="testbed.cpp" />
   </ItemGroup>
+  <ItemGroup>
+    <ResourceCompile Include="..\blank.rc" />
+  </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">
   </ImportGroup>

diff --git a/examples/Testbed/Testbed.vcxproj.filters b/examples/Testbed/Testbed.vcxproj.filters
@@ -19,4 +19,9 @@
       <Filter>Source Files</Filter>
     </ClCompile>
   </ItemGroup>
+  <ItemGroup>
+    <ResourceCompile Include="..\blank.rc">
+      <Filter>Resource Files</Filter>
+    </ResourceCompile>
+  </ItemGroup>
 </Project>
diff --git a/examples/Testbed/testbed.cpp b/examples/Testbed/testbed.cpp
@@ -3,7 +3,8 @@
 * This example runs a series of tests to ensure Magnesium is
 * working correctly
 *
-* Copyright ©2016 Black Sphere Studios
+* Copyright ©2018 Black Sphere Studios
+* For conditions of distribution and use, see copyright notice in Magnesium.h
 */
 
 #include "magnesium/mgEngine.h"

diff --git a/examples/blank.rc b/examples/blank.rc
@@ -0,0 +1 @@
+101       ICON         "..\\magnesium.ico"
diff --git a/examples/magnesium.ico b/examples/magnesium.ico
diff --git a/include/magnesium/Magnesium.h b/include/magnesium/Magnesium.h
@@ -1,7 +1,17 @@
 /* Magnesium Game Engine
-Copyright ©2017 Black Sphere Studios
+Copyright ©2018 Black Sphere Studios
 
-Proprietary license. This code may not be distributed or modified in any way.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 */
 
 #ifndef __MAGNESIUM_H__MG__

diff --git a/include/magnesium/mgBox2D.h b/include/magnesium/mgBox2D.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __BOX2D_H__MG__

diff --git a/include/magnesium/mgComponent.h b/include/magnesium/mgComponent.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __COMPONENT_H__MG__
@@ -37,7 +37,13 @@ namespace magnesium {
       inline void deallocate(T* p, size_t sz = 0) noexcept { mgComponentStoreBase::dllfree(p); }
     };
 
-    struct EntityIterator : public std::iterator<std::bidirectional_iterator_tag, mgEntity*> {
+    struct EntityIterator {
+      using iterator_category = std::bidirectional_iterator_tag;
+      using value_type = mgEntity*;
+      using difference_type = ptrdiff_t;
+      using pointer = mgEntity*;
+      using reference = mgEntity*;
+
       inline EntityIterator(void* p_, size_t len_, size_t type_) : p(reinterpret_cast<uint8_t*>(p_)), end(reinterpret_cast<uint8_t*>(p_) + (len_*type_)), type(type_) {}
       inline mgEntity* operator*() const { return *reinterpret_cast<mgEntity**>(p); }
       inline EntityIterator& operator++() { p += type; return *this; } //prefix

diff --git a/include/magnesium/mgConsole.h b/include/magnesium/mgConsole.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __CONSOLE_H__MG__

diff --git a/include/magnesium/mgControlMap.h b/include/magnesium/mgControlMap.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __CONTROL_MAP_H__MG__

diff --git a/include/magnesium/mgEngine.h b/include/magnesium/mgEngine.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __ENGINE_H__MG__

diff --git a/include/magnesium/mgEntity.h b/include/magnesium/mgEntity.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __ENTITY_H__MG__

diff --git a/include/magnesium/mgJoinPSB2.h b/include/magnesium/mgJoinPSB2.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __JOIN_PS_B2_H__MG__

diff --git a/include/magnesium/mgLogic.h b/include/magnesium/mgLogic.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __LOGIC_H__MG__

diff --git a/include/magnesium/mgLua.h b/include/magnesium/mgLua.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __LUA_H__MG__

diff --git a/include/magnesium/mgPlaneshader.h b/include/magnesium/mgPlaneshader.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __PLANESHADER_H__MG__

diff --git a/include/magnesium/mgRefCounter.h b/include/magnesium/mgRefCounter.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __REF_COUNTER_H__MG__

diff --git a/include/magnesium/mgSystem.h b/include/magnesium/mgSystem.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __SYSTEM_H__MG__

diff --git a/include/magnesium/mgSystemManager.h b/include/magnesium/mgSystemManager.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __SYSTEM_MANAGER_H__MG__

diff --git a/include/magnesium/mgTimeline.h b/include/magnesium/mgTimeline.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __TIMELINE_H__MG__

diff --git a/include/magnesium/mgTinyOAL.h b/include/magnesium/mgTinyOAL.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __TINYOAL_H__MG__

diff --git a/include/magnesium/mg_dec.h b/include/magnesium/mg_dec.h
@@ -1,4 +1,4 @@
-// Copyright ©2017 Black Sphere Studios
+// Copyright ©2018 Black Sphere Studios
 // For conditions of distribution and use, see copyright notice in Magnesium.h
 
 #ifndef __DEC_H__MG__

diff --git a/pack.bat b/pack.bat
@@ -0,0 +1,30 @@
+@ECHO OFF
+md "..\Packages\Magnesium"
+
+RMDIR /S /Q ".\Debug\"
+RMDIR /S /Q ".\Release\"
+RMDIR /S /Q ".\x64\"
+RMDIR /S /Q ".\Win32\"
+RMDIR /S /Q ".\examples\x64\"
+RMDIR /S /Q ".\examples\Win32\"
+RMDIR /S /Q ".\examples\LD34\x64\"
+RMDIR /S /Q ".\examples\LD34\Win32\"
+RMDIR /S /Q ".\examples\Testbed\x64\"
+RMDIR /S /Q ".\examples\Testbed\Win32\"
+RMDIR /S /Q ".\Magnesium\x64\"
+RMDIR /S /Q ".\Magnesium\Win32\"
+DEL /F /S /Q *.log *.exp *.idb *.ilk *.iobj *.ipdb *.metagen *.pch
+DEL /F /Q ".\bin\Testbed*.lib"
+DEL /F /Q ".\bin32\Testbed*.lib"
+DEL /F /Q ".\bin\Testbed*.pdb"
+DEL /F /Q ".\bin32\Testbed*.pdb"
+DEL /F /Q ".\bin\LD34*.lib"
+DEL /F /Q ".\bin32\LD34*.lib"
+DEL /F /Q ".\bin\LD34*.pdb"
+DEL /F /Q ".\bin32\LD34*.pdb"
+XCOPY *.* "..\Packages\Magnesium" /S /C /I /R /Y
+DEL /F /Q "..\Packages\Magnesium\bin\D3D*.dll"
+DEL /F /Q "..\Packages\Magnesium\bin\D3D*.pdb"
+DEL /F /Q "..\Packages\Magnesium\bin32\D3D*.dll"
+DEL /F /Q "..\Packages\Magnesium\bin32\D3D*.pdb"
+DEL /F /S /Q "..\Packages\Magnesium\*.zip"