fix some warnings, finish documentation (for now)

nbproject/private/CodeAssistancePathMapper.properties

@@ -0,0 +1 @@
+# Automatic path mapper. CRC = 1

nbproject/private/c_standard_headers_indexer.c

@@ -0,0 +1,75 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+ *
+ * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
+ * Other names may be trademarks of their respective owners.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common
+ * Development and Distribution License("CDDL") (collectively, the
+ * "License"). You may not use this file except in compliance with the
+ * License. You can obtain a copy of the License at
+ * http://www.netbeans.org/cddl-gplv2.html
+ * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
+ * specific language governing permissions and limitations under the
+ * License.  When distributing the software, include this License Header
+ * Notice in each file and include the License file at
+ * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the GPL Version 2 section of the License file that
+ * accompanied this code. If applicable, add the following below the
+ * License Header, with the fields enclosed by brackets [] replaced by
+ * your own identifying information:
+ * "Portions Copyrighted [year] [name of copyright owner]"
+ *
+ * If you wish your version of this file to be governed by only the CDDL
+ * or only the GPL Version 2, indicate your decision by adding
+ * "[Contributor] elects to include this software in this distribution
+ * under the [CDDL or GPL Version 2] license." If you do not indicate a
+ * single choice of license, a recipient has the option to distribute
+ * your version of this file under either the CDDL, the GPL Version 2 or
+ * to extend the choice of license to its licensees as provided above.
+ * However, if you add GPL Version 2 code and therefore, elected the GPL
+ * Version 2 license, then the option applies only if the new code is
+ * made subject to such option by the copyright holder.
+ *
+ * Contributor(s):
+ */
+
+// List of standard headers was taken in http://en.cppreference.com/w/c/header
+
+#include <assert.h> 	 // Conditionally compiled macro that compares its argument to zero
+#include <ctype.h> 	 // Functions to determine the type contained in character data
+#include <errno.h> 	 // Macros reporting error conditions
+#include <float.h> 	 // Limits of float types
+#include <limits.h> 	 // Sizes of basic types
+#include <locale.h> 	 // Localization utilities
+#include <math.h> 	 // Common mathematics functions
+#include <setjmp.h> 	 // Nonlocal jumps
+#include <signal.h> 	 // Signal handling
+#include <stdarg.h> 	 // Variable arguments
+#include <stddef.h> 	 // Common macro definitions
+#include <stdio.h> 	 // Input/output
+#include <string.h> 	 // String handling
+#include <stdlib.h> 	 // General utilities: memory management, program utilities, string conversions, random numbers
+#include <time.h> 	 // Time/date utilities
+#include <iso646.h>      // (since C95) Alternative operator spellings
+#include <wchar.h>       // (since C95) Extended multibyte and wide character utilities
+#include <wctype.h>      // (since C95) Wide character classification and mapping utilities
+#ifdef _STDC_C99
+#include <complex.h>     // (since C99) Complex number arithmetic
+#include <fenv.h>        // (since C99) Floating-point environment
+#include <inttypes.h>    // (since C99) Format conversion of integer types
+#include <stdbool.h>     // (since C99) Boolean type
+#include <stdint.h>      // (since C99) Fixed-width integer types
+#include <tgmath.h>      // (since C99) Type-generic math (macros wrapping math.h and complex.h)
+#endif
+#ifdef _STDC_C11
+#include <stdalign.h>    // (since C11) alignas and alignof convenience macros
+#include <stdatomic.h>   // (since C11) Atomic types
+#include <stdnoreturn.h> // (since C11) noreturn convenience macros
+#include <threads.h>     // (since C11) Thread library
+#include <uchar.h>       // (since C11) UTF-16 and UTF-32 character utilities
+#endif

nbproject/private/configurations.xml

@@ -4256,16 +4256,6 @@
         </df>
       </df>
       <df name="object">
-        <df name="data">
-          <df name="item">
-          </df>
-          <df name="moves">
-          </df>
-          <df name="overworld">
-          </df>
-          <df name="pkmn_tables">
-          </df>
-        </df>
         <df name="src">
           <df name="assets">
             <df name="meteor">
@@ -4363,7 +4353,7 @@
           </df>
         </df>
         <df name="string">
-          <df name="de">
+          <df name="DE">
           </df>
         </df>
       </df>
@@ -5700,7 +5690,6 @@
               <in>snd_127_soft_snare.s</in>
               <in>snd_127_sticks.s</in>
               <in>snd_127_tambourine.s</in>
-              <in>snd_127_tom.s</in>
               <in>snd_127_tom_45.s</in>
               <in>snd_127_tom_48.s</in>
               <in>snd_127_triangle.s</in>
@@ -6025,7 +6014,6 @@
           <in>battle_switch_in_hook.S</in>
           <in>battle_test.c</in>
           <in>custom_structs_malloc.c</in>
-          <in>custom_structs_malloc.h</in>
           <in>custom_structs_malloc_hook.S</in>
           <in>entry_hazards.c</in>
           <in>entry_hazards_hook.S</in>
@@ -6044,10 +6032,11 @@
             <in>ascii.c</in>
             <in>ascii.h</in>
           </df>
-          <in>abilities.h</in>
           <in>attack_names.h</in>
-          <in>battle.h</in>
           <in>battle_abilities.h</in>
+          <in>battle_common.h</in>
+          <in>battle_custom_structs.h</in>
+          <in>battle_fractions.h</in>
           <in>battle_help.h</in>
           <in>battle_initiative.h</in>
           <in>battle_locations.h</in>
@@ -6057,20 +6046,20 @@
           <in>bpre.h</in>
           <in>callback.h</in>
           <in>config.h</in>
-          <in>custom_structs.h</in>
           <in>debug.h</in>
           <in>dns_core.h</in>
           <in>fade.h</in>
           <in>game_engine.h</in>
-          <in>item_effects.h</in>
-          <in>items.h</in>
           <in>lcd.h</in>
           <in>math.h</in>
           <in>memory.h</in>
           <in>moves.h</in>
           <in>objects.h</in>
           <in>oe_animation.h</in>
+          <in>pkmn_abilities.h</in>
           <in>pkmn_attributes.h</in>
+          <in>pkmn_item_effects.h</in>
+          <in>pkmn_items.h</in>
           <in>pkmn_types.h</in>
           <in>pokemon.h</in>
           <in>sound.h</in>
@@ -6234,11 +6223,8 @@
       </df>
       <df name="string">
         <df name="de">
-          <in>move_descriptions.txt</in>
-          <in>move_names.txt</in>
         </df>
         <df name="en">
-          <in>move_strings.txt</in>
         </df>
       </df>
       <df name="todo">

nbproject/private/cpp_standard_headers_indexer.cpp

@@ -0,0 +1,135 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+ *
+ * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
+ * Other names may be trademarks of their respective owners.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common
+ * Development and Distribution License("CDDL") (collectively, the
+ * "License"). You may not use this file except in compliance with the
+ * License. You can obtain a copy of the License at
+ * http://www.netbeans.org/cddl-gplv2.html
+ * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
+ * specific language governing permissions and limitations under the
+ * License.  When distributing the software, include this License Header
+ * Notice in each file and include the License file at
+ * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the GPL Version 2 section of the License file that
+ * accompanied this code. If applicable, add the following below the
+ * License Header, with the fields enclosed by brackets [] replaced by
+ * your own identifying information:
+ * "Portions Copyrighted [year] [name of copyright owner]"
+ *
+ * If you wish your version of this file to be governed by only the CDDL
+ * or only the GPL Version 2, indicate your decision by adding
+ * "[Contributor] elects to include this software in this distribution
+ * under the [CDDL or GPL Version 2] license." If you do not indicate a
+ * single choice of license, a recipient has the option to distribute
+ * your version of this file under either the CDDL, the GPL Version 2 or
+ * to extend the choice of license to its licensees as provided above.
+ * However, if you add GPL Version 2 code and therefore, elected the GPL
+ * Version 2 license, then the option applies only if the new code is
+ * made subject to such option by the copyright holder.
+ *
+ * Contributor(s):
+ */
+
+// List of standard headers was taken in http://en.cppreference.com/w/cpp/header
+
+#include <cstdlib> 	    // General purpose utilities: program control, dynamic memory allocation, random numbers, sort and search
+#include <csignal> 	    // Functions and macro constants for signal management
+#include <csetjmp> 	    // Macro (and function) that saves (and jumps) to an execution context
+#include <cstdarg> 	    // Handling of variable length argument lists
+#include <typeinfo> 	    // Runtime type information utilities
+#include <bitset> 	    // std::bitset class template
+#include <functional> 	    // Function objects, designed for use with the standard algorithms
+#include <utility> 	    // Various utility components
+#include <ctime> 	    // C-style time/date utilites
+#include <cstddef> 	    // typedefs for types such as size_t, NULL and others
+#include <new> 	            // Low-level memory management utilities
+#include <memory> 	    // Higher level memory management utilities
+#include <climits>          // limits of integral types
+#include <cfloat> 	    // limits of float types
+#include <limits> 	    // standardized way to query properties of arithmetic types
+#include <exception> 	    // Exception handling utilities
+#include <stdexcept> 	    // Standard exception objects
+#include <cassert> 	    // Conditionally compiled macro that compares its argument to zero
+#include <cerrno>           // Macro containing the last error number
+#include <cctype>           // functions to determine the type contained in character data
+#include <cwctype>          // functions for determining the type of wide character data
+#include <cstring> 	    // various narrow character string handling functions
+#include <cwchar> 	    // various wide and multibyte string handling functions
+#include <string> 	    // std::basic_string class template
+#include <vector> 	    // std::vector container
+#include <deque> 	    // std::deque container
+#include <list> 	    // std::list container
+#include <set> 	            // std::set and std::multiset associative containers
+#include <map> 	            // std::map and std::multimap associative containers
+#include <stack> 	    // std::stack container adaptor
+#include <queue> 	    // std::queue and std::priority_queue container adaptors
+#include <algorithm> 	    // Algorithms that operate on containers
+#include <iterator> 	    // Container iterators
+#include <cmath>            // Common mathematics functions
+#include <complex>          // Complex number type
+#include <valarray>         // Class for representing and manipulating arrays of values
+#include <numeric>          // Numeric operations on values in containers
+#include <iosfwd>           // forward declarations of all classes in the input/output library
+#include <ios>              // std::ios_base class, std::basic_ios class template and several typedefs
+#include <istream>          // std::basic_istream class template and several typedefs
+#include <ostream>          // std::basic_ostream, std::basic_iostream class templates and several typedefs
+#include <iostream>         // several standard stream objects
+#include <fstream>          // std::basic_fstream, std::basic_ifstream, std::basic_ofstream class templates and several typedefs
+#include <sstream>          // std::basic_stringstream, std::basic_istringstream, std::basic_ostringstream class templates and several typedefs
+#include <strstream>        // std::strstream, std::istrstream, std::ostrstream(deprecated)
+#include <iomanip>          // Helper functions to control the format or input and output
+#include <streambuf>        // std::basic_streambuf class template
+#include <cstdio>           // C-style input-output functions
+#include <locale>           // Localization utilities
+#include <clocale>          // C localization utilities
+#include <ciso646>          // empty header. The macros that appear in iso646.h in C are keywords in C++
+#if __cplusplus >= 201103L
+#include <typeindex>        // (since C++11) 	std::type_index
+#include <type_traits>      // (since C++11) 	Compile-time type information
+#include <chrono>           // (since C++11) 	C++ time utilites
+#include <initializer_list> // (since C++11) 	std::initializer_list class template
+#include <tuple>            // (since C++11) 	std::tuple class template
+#include <scoped_allocator> // (since C++11) 	Nested allocator class
+#include <cstdint>          // (since C++11) 	fixed-size types and limits of other types
+#include <cinttypes>        // (since C++11) 	formatting macros , intmax_t and uintmax_t math and conversions
+#include <system_error>     // (since C++11) 	defines std::error_code, a platform-dependent error code
+#include <cuchar>           // (since C++11) 	C-style Unicode character conversion functions
+#include <array>            // (since C++11) 	std::array container
+#include <forward_list>     // (since C++11) 	std::forward_list container
+#include <unordered_set>    // (since C++11) 	std::unordered_set and std::unordered_multiset unordered associative containers
+#include <unordered_map>    // (since C++11) 	std::unordered_map and std::unordered_multimap unordered associative containers
+#include <random>           // (since C++11) 	Random number generators and distributions
+#include <ratio>            // (since C++11) 	Compile-time rational arithmetic
+#include <cfenv>            // (since C++11) 	Floating-point environment access functions
+#include <codecvt>          // (since C++11) 	Unicode conversion facilities
+#include <regex>            // (since C++11) 	Classes, algorithms and iterators to support regular expression processing
+#include <atomic>           // (since C++11) 	Atomic operations library
+#include <ccomplex>         // (since C++11)(deprecated in C++17) 	simply includes the header <complex>
+#include <ctgmath>          // (since C++11)(deprecated in C++17) 	simply includes the headers <ccomplex> (until C++17)<complex> (since C++17) and <cmath>: the overloads equivalent to the contents of the C header tgmath.h are already provided by those headers
+#include <cstdalign>        // (since C++11)(deprecated in C++17) 	defines one compatibility macro constant
+#include <cstdbool>         // (since C++11)(deprecated in C++17) 	defines one compatibility macro constant
+#include <thread>           // (since C++11) 	std::thread class and supporting functions
+#include <mutex>            // (since C++11) 	mutual exclusion primitives
+#include <future>           // (since C++11) 	primitives for asynchronous computations
+#include <condition_variable> // (since C++11) 	thread waiting conditions
+#endif
+#if __cplusplus >= 201300L
+#include <shared_mutex>     // (since C++14) 	shared mutual exclusion primitives
+#endif
+#if __cplusplus >= 201500L
+#include <any>              // (since C++17) 	std::any class template
+#include <optional>         // (since C++17) 	std::optional class template
+#include <variant>          // (since C++17) 	std::variant class template
+#include <memory_resource>  // (since C++17) 	Polymorphic allocators and memory resources
+#include <string_view>      // (since C++17) 	std::basic_string_view class template
+#include <execution>        // (since C++17) 	Predefined execution policies for parallel versions of the algorithms
+#include <filesystem>       // (since C++17) 	std::path class and supporting functions
+#endif

nbproject/private/private.xml

@@ -19,83 +19,43 @@
     </editor-bookmarks>
     <open-files xmlns="http://www.netbeans.org/ns/projectui-open-files/2">
         <group>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/include/bpre.h</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/string/table.tbl</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/battle_engine/battle_end_of_turn_hook.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/main.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/moves/metal_burst/metal_burst_script.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/include/config.h</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/moves/roost/roost_scripts.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/include/moves.h</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/overworld/trainer_run.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/move_table.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/battle_engine/custom_structs_malloc.c</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/disable_cry_table_blocks.s</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/battle_engine/custom_structs_malloc.h</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/include/battle_locations.h</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/moves/bride/bride.c</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/include/item_effects.h</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/battle_engine/entry_hazards.c</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/music.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/battle_engine/battle_end_of_turn.c</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/specials/custom_specials.c</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/sprites.makefile</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/overworlds/overworld.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/data/moves/effect_table.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/makefile</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/overworld/overworld.c</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/string/de/item_data.txt</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/dynamic_overworld_hooks.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/include/battle.h</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/moves.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/data/pkmn_tables/pokemon_moveset_table.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/include/types.h</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/overworld/overworld_hooks.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/battle_engine/battle_engine.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/moves/feint/feint.c</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/icons.makefile</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/items/item_limits.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/items/tm_fixes.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/string/de/item_descriptions.txt</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/hooks.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/battle_engine/battle_switch_in_hook.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/data/item/tm_hm_move_table.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/items/item_routines.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/dns/dns_core.c</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/data/moves/animation_table.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/moves/uturn/u_turn_script.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/data/item/item_scripts.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/gfx_build/overworlds/.gitignore</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/linker.ld</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/moves/tailwind/tailwind_scripts.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/moves/tailwind/tailwind.c</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/overworlds/trainer.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/moves/battle_engine/bs_table.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/include/battle_structs.h</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/battle_engine/battle_initiative.c</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/special.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/include/custom_structs.h</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/moves/metal_burst/metal_burst.c</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/string/de/hazards.txt</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/battle_engine/custom_structs_malloc_hook.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/battle_engine/battle_test.c</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/assets.makefile</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/moves/bride/bride_scripts.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/moves/feint/feint_scripts.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/items/item_tables.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/gfx_build/sprites/back_sprites/.gitignore</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/split_physical_special.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/battle_engine/malloc.asm</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/bpre.sym</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/moves/roost/roost.c</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/moves/hazards/hazards_scripts.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/include/battle_script.h</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/battle_engine/entry_hazards_hook.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/data/moves/move_data.S</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/interface/textbox_mugshots.c</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/string/de/move_strings.txt</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/src/include/battle_abilities.h</file>
-            <file>file:/C:/cygwin64/home/auerp/sots/source_of_the_sovereign/patches/items/items.asm</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/battle_engine/battle_help.c</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/moves.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/battle_engine/custom_structs_malloc.c</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/specials/cutscene_meteor.c</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/battle.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/makefile</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/battle_script.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/memory.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/overworld/overworld.c</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/battle_locations.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/attack_names.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/battle_abilities.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/pkmn_abilities.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/game_engine.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/battle_engine/battle_initiative.c</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/interface/textbox_mugshots.c</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/patches/hooks.asm</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/battle_engine/battle_abilities.c</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/types.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/battle_test.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/battle_initiative.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/pkmn_item_effects.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/moves/ability_changers/ability_change.c</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/specials/custom_specials.c</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/pkmn_attributes.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/lcd.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/math.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/moves/feint/feint.c</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/battle_help.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/battle_engine/battle_test.c</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/specials/camera_move.c</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/debug.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/string/de/item_data.txt</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/include/battle_structs.h</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/debug/debug.c</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/battle_engine/entry_hazards.c</file>
+            <file>file:/C:/cygwin64/home/Philipp/sots/engine/source_of_the_sovereign/src/moves/assurance/assurance.c</file>
         </group>
     </open-files>
 </project-private>

patches/dns/core.asm

@@ -1,24 +1,24 @@
 .org 0x08059A90
-    ldr r3, =mapdata_load_palette_one+1
+    ldr r3, =dns_mapdata_load_palette_one+1
     bx r3
     .pool
 
 .org 0x08059AA0
-    ldr r3, =mapdata_load_palette_two+1
+    ldr r3, =dns_mapdata_load_palette_two+1
     bx r3
     .pool
 
 .org 0x0805F538
-    ldr r2, =pal_patch_for_npc+1
+    ldr r2, =dns_pal_patch_for_npc+1
     bx r2
     .pool
 
 .org 0x08083614
-    ldr r1, =overworld_anim_load_pal+1
+    ldr r1, =dns_overworld_anim_load_pal+1
     bx r1
     .pool
 
 .org 0x08056578
-    ldr r0, =overworld_loop+1
+    ldr r0, =dns_cb_overworld_hacked+1
     bx r0
     .pool

patches/special.asm

@@ -1,2 +1,2 @@
 .org 0x0815FD60 + (4 * 0x68) //special 0x68
-.word special_asm|1
+.word sp_special_casm|1

src/battle_engine/battle_abilities.c

@@ -1,9 +1,39 @@
-#include <battle_abilities.h>
-#include <custom_structs.h>
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file battle_abilities.c
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Some methods concerning in-battle abilities
+ */
 
-#include "battle_structs.h"
+/* === INCLUDE === */
+#include <battle_abilities.h>
+#include <battle_custom_structs.h>
+#include <battle_structs.h>
 
-u8 has_ability_effect(u8 bank, u8 mold_breaker, u8 gastro)
+/* === IMPLEMENTATIONS === */
+u8 ability_has_effect(u8 bank, u8 mold_breaker, u8 gastro)
 {
     if(gastro && custom_battle_elements.ptr->bank_affecting[bank].gastro_acided)
         return false;
@@ -11,12 +41,12 @@ u8 has_ability_effect(u8 bank, u8 mold_breaker, u8 gastro)
     //TODO: MOLD BREAKER
 }
 
-u8 weather_abilities_effect()
+u8 ability_weather_effects()
 {
     //TODO: AIR LOCK AND CLOUD NINE
     return true;
 }
-u8 has_ability(u8 bank, u8 ability)
+u8 ability_has_ability(u8 bank, u8 ability)
 {
-    return (has_ability_effect(bank,0,1) && battle_participants[bank].ability_id == ability);
+    return (ability_has_effect(bank,0,1) && battle_participants[bank].ability_id == ability);
 }

src/battle_engine/battle_end_of_turn.c

@@ -1,5 +1,45 @@
-#include <battle.h>
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
 
+/**
+ * @file battle_end_of_turn.c
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Handle end of turn effects
+ */
+
+/* === INCLUDE === */
+
+#include <battle_structs.h>
+#include <pkmn_types.h>
+
+/* === PROTOTYPES === */
+
+/**
+ * @brief handle the end of turn stuff
+ */
+void battle_end_of_turn();
+
+/* === IMPLEMENTATIONS === */
 void battle_end_of_turn() {
     for (int i = 0; i < 4; ++i) {
         if (battle_participants[i].type1 == TYPE_EGG)

src/battle_engine/battle_help.c

@@ -1,7 +1,48 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file battle_help.c
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Some general helper methods for battle
+ */
+
+/* === INCLUDE === */
+
 #include <battle_help.h>
+#include <battle_locations.h>
+#include <battle_custom_structs.h>
+#include <game_engine.h>
+#include <pkmn_types.h>
+#include <pkmn_abilities.h>
+#include <pkmn_item_effects.h>
+#include <pkmn_items.h>
+#include <pkmn_attributes.h>
+#include <battle_common.h>
 
-//from kds emerald battle engine upgrade
+/* === STATICS === */
 
+/* from kds emerald battle engine upgrade */
 u8 type_effectiveness_table[TYPE_FAIRY - 0x4][TYPE_FAIRY - 0x4] = {
     {10, 10, 10, 10, 10, 05, 10, 00, 05, 10, 10, 10, 10, 10, 10, 10, 10, 10, 10}, //normal
     {20, 10, 05, 05, 10, 20, 05, 00, 20, 10, 10, 10, 10, 10, 05, 20, 10, 20, 05}, //fight
@@ -24,7 +65,8 @@ u8 type_effectiveness_table[TYPE_FAIRY - 0x4][TYPE_FAIRY - 0x4] = {
     {10, 20, 10, 05, 10, 10, 10, 10, 05, 10, 05, 10, 10, 10, 10, 10, 20, 20, 10} //fairy
 };
 
-u16 damage_type_effectiveness_update(u8 attacking_type, u8 defending_type, u8 atk_bank, u8 def_bank, u16 chained_effect, u8 airstatus) {
+/* === IMPLEMENTATIONS === */
+u16 battle_damage_type_effectiveness_update(u8 attacking_type, u8 defending_type, u8 atk_bank, u8 def_bank, u16 chained_effect, u8 airstatus) {
     u8 effect, atype = attacking_type, dtype = defending_type;
     if (!chained_effect || atype == TYPE_EGG || dtype == TYPE_EGG)
         return chained_effect;
@@ -64,32 +106,32 @@ u16 damage_type_effectiveness_update(u8 attacking_type, u8 defending_type, u8 at
 
 }
 
-u16 apply_type_effectiveness(u16 chained_effect, u8 move_type, u8 target_bank, u8 atk_bank, u8 airstatus) {
+u16 battle_apply_type_effectiveness(u16 chained_effect, u8 move_type, u8 target_bank, u8 atk_bank, u8 airstatus) {
     u8 defender_type1 = battle_participants[target_bank].type1;
     u8 defender_type2 = battle_participants[target_bank].type2;
     //set different types
     if (defender_type2 == defender_type1)
         defender_type2 = TYPE_EGG;
-    chained_effect = damage_type_effectiveness_update(move_type, defender_type1, atk_bank, target_bank, chained_effect, airstatus);
-    chained_effect = damage_type_effectiveness_update(move_type, defender_type2, atk_bank, target_bank, chained_effect, airstatus);
+    chained_effect = battle_damage_type_effectiveness_update(move_type, defender_type1, atk_bank, target_bank, chained_effect, airstatus);
+    chained_effect = battle_damage_type_effectiveness_update(move_type, defender_type2, atk_bank, target_bank, chained_effect, airstatus);
     return chained_effect;
 }
 
-u16 type_effectiveness_calc(u16 move, u8 move_type, u8 atk_bank, u8 def_bank, u8 effects_handling_and_recording) {
+u16 battle_type_effectiveness_calc(u16 move, u8 move_type, u8 atk_bank, u8 def_bank, u8 effects_handling_and_recording) {
     u16 chained_effect = 64;
     //TODO: double_type moves
     //TODO: get air status
-    chained_effect = apply_type_effectiveness(chained_effect, move_type, def_bank, atk_bank, 2);
+    chained_effect = battle_apply_type_effectiveness(chained_effect, move_type, def_bank, atk_bank, 2);
     //TODO: save into structs
-    //TODO: effect_handling_and_recoring
+    //TODO: effect_handling_and_recording
     return chained_effect;
 }
 
-u8 has_type(u8 bank, u8 type) {
+u8 battle_bank_has_type(u8 bank, u8 type) {
     return battle_participants[bank].type1 == type || battle_participants[bank].type2 == type;
 }
 
-u8 get_item_effect(u8 bank, u8 check_negating_effects) {
+u8 battle_item_get_effect(u8 bank, u8 check_negating_effects) {
     if (check_negating_effects) {
         if (battle_participants[bank].ability_id == ABILITY_KLUTZ || custom_battle_elements.ptr->bank_affecting[bank].embargo)
             return ITEM_EFFECT_NOEFFECT;
@@ -101,7 +143,7 @@ u8 get_item_effect(u8 bank, u8 check_negating_effects) {
     }
 }
 
-u8 cant_poison(u8 bank, u8 self_inflicted) { //0 == can poison
+u8 battle_bank_is_poison_resistant(u8 bank, u8 self_inflicted) { //0 == can poison
     //1 == is already poisoned
     //2 == has other major condition
     //3 == type doesn't allow it
@@ -112,7 +154,7 @@ u8 cant_poison(u8 bank, u8 self_inflicted) { //0 == can poison
         return 1;
     if (battle_participants[bank].status.int_status)
         return 2;
-    if (has_type(bank, TYPE_POISON) || has_type(bank, TYPE_STEEL))
+    if (battle_bank_has_type(bank, TYPE_POISON) || battle_bank_has_type(bank, TYPE_STEEL))
         return 3;
     if (((battle_participants[bank].ability_id == ABILITY_IMMUNITY || (battle_participants[bank].ability_id == ABILITY_LEAF_GUARD && (battle_weather.flags.sun || battle_weather.flags.permament_sun || battle_weather.flags.harsh_sun)))))
         return 4;
@@ -121,7 +163,7 @@ u8 cant_poison(u8 bank, u8 self_inflicted) { //0 == can poison
     return 0;
 }
 
-u8 count_party_pokemon(u8 bank)
+u8 battle_count_party_pokemon(u8 bank)
 {
     struct pokemon* poke;
     if (get_side_from_bank(bank))

src/battle_engine/battle_initiative.c

@@ -1,12 +1,56 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file battle_initiative.c
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Methods calculating speed based stats in-battle
+ */
+
+/* === INCLUDE === */
+
 #include <battle_initiative.h>
-#include <battle.h>
+#include <pkmn_item_effects.h>
+#include <pokemon.h>
 #include <battle_help.h>
-#include <bpre.h>
+#include <pkmn_abilities.h>
+#include <math.h>
+#include <battle_common.h>
+#include <battle_abilities.h>
+#include <battle_structs.h>
+#include <battle_locations.h>
+#include <battle_custom_structs.h>
+#include <battle_fractions.h>
+
+/* === EXTERN STRUCTS === */
+
 struct move_info move_table[1024];
 
+/* === IMPLEMENTATIONS === */
+
 u16 get_speed(u8 bank) {
     u32 speed = battle_participants[bank].spd << 16;
-    switch (get_item_effect(bank, 1)) {
+    switch (battle_item_get_effect(bank, 1)) {
         case ITEM_EFFECT_IRONBALL:
             speed >>= 1;
             break;
@@ -18,8 +62,8 @@ u16 get_speed(u8 bank) {
                 speed <<= 1;
             break;
     }
-    if (has_ability_effect(bank, 0, 1)) {
-        u8 weather_effects = weather_abilities_effect();
+    if (ability_has_effect(bank, 0, 1)) {
+        u8 weather_effects = ability_weather_effects();
         switch (battle_participants[bank].ability_id) {
             case ABILITY_CHLOROPHYLL:
                 if (weather_effects && (battle_weather.flags.harsh_sun || battle_weather.flags.permament_sun || battle_weather.flags.sun))
@@ -96,15 +140,15 @@ enum init_enum get_first_to_strike(u8 bank_one, u8 bank_two, u8 ignore_prio) {
             result = TWO;
     }
     if (result == TIE) {
-        s8 brack_one = speed_alt_from_item(bank_one, get_item_effect(bank_one, true));
-        s8 brack_two = speed_alt_from_item(bank_two, get_item_effect(bank_two, true));
+        s8 brack_one = speed_alt_from_item(bank_one, battle_item_get_effect(bank_one, true));
+        s8 brack_two = speed_alt_from_item(bank_two, battle_item_get_effect(bank_two, true));
         if (brack_one > brack_two)
             result = ONE;
         else if (brack_two > brack_one)
             result = TWO;
         else {
-            u8 stall_one = has_ability(bank_one, ABILITY_STALL);
-            u8 stall_two = has_ability(bank_two, ABILITY_STALL);
+            u8 stall_one = ability_has_ability(bank_one, ABILITY_STALL);
+            u8 stall_two = ability_has_ability(bank_two, ABILITY_STALL);
             if (stall_one && !stall_two)
                 result = TWO;
             else if (stall_two && !stall_one)

src/battle_engine/battle_test.c

@@ -1,9 +1,40 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file battle_test.c
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Unit tests for battles, very temporary and undocumented
+ */
+
+#include <types.h>
 #include <battle_test.h>
-#include <battle.h>
-#include <bpre.h>
 #include <debug.h>
 #include <battle_initiative.h>
-#include <abilities.h>
+#include <pkmn_abilities.h>
+#include <battle_structs.h>
+#include <battle_common.h>
+#include <battle_custom_structs.h>
 
 #define TEST_AMOUNT 10000
 

src/battle_engine/custom_structs_malloc.c

@@ -1,19 +1,70 @@
-#include <bpre.h>
-#include <battle.h>
-#include "custom_structs.h"
-#include "custom_structs_malloc.h"
-#include <debug.h>
-#include <items.h>
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file custom_structs_malloc.c
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Patch hacks for handling custom battle structures
+ */
+
+
+/* === INCLUDE === */
+
+#include <battle_custom_structs.h>
+#include <game_engine.h>
+#include <memory.h>
+#include <moves.h>
+#include <battle_common.h>
+#include <battle_locations.h>
+
+/* === PROTOTYPES === */
+
+/**
+ * @brief allocate the new battle struct memory
+ */
+void malloc_battle_structs();
+
+/**
+ * @brief free the new battle struct memory
+ */
+void free_battle_structs();
+
+/**
+ * @brief handle switch in uptates on structures
+ */
+void battle_switch_in();
+
+/* === IMPLEMENTATIONS === */
 
 void malloc_battle_structs()
 {
-	custom_battle_elements.ptr=(struct custom_battle_struct*)malloc(sizeof(struct custom_battle_struct));
+    custom_battle_elements.ptr=(struct custom_battle_struct*)malloc(sizeof(struct custom_battle_struct));
 }
 
 void free_battle_structs()
 {
-	free(custom_battle_elements.ptr);
-	custom_battle_elements.ptr=0;
+    free(custom_battle_elements.ptr);
+    custom_battle_elements.ptr=0;
 }
 
 //hijack switch in command, clean up battle structs and carry over baton pass
@@ -52,4 +103,4 @@ void battle_switch_in()
     active_side->lunardance_done = 0;
     
     return;
-}
+}

src/battle_engine/custom_structs_malloc.h

@@ -1,8 +0,0 @@
-#ifndef CUSTOM_S_MAL_H_
-#define CUSTOM_S_MAL_H_
-
-void malloc_battle_structs();
-void free_battle_structs();
-void battle_switch_in();
-
-#endif

src/battle_engine/entry_hazards.c

@@ -1,5 +1,42 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file entry_hazards.c
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Handle entry hazards
+ */
+
+/* === INCLUDE === */
 #include <battle_help.h>
-#include <bpre.h>
+#include <battle_locations.h>
+#include <moves.h>
+#include <battle_structs.h>
+#include <battle_custom_structs.h>
+#include <pkmn_types.h>
+#include <battle_common.h>
+
+/* === EXTERN STATICS === */
 
 extern void* bs_stealth_rock;
 extern void* bs_toxic_spikes;
@@ -16,6 +53,20 @@ extern void* bs_lunar_dance_exec;
 
 extern void* str_lunardance_executed_ref;
 
+/* === PROTOTYPES === */
+/**
+ * @brief execute entry hazards scripts if they are lain
+ * @return true if there was an effect, false otherwise
+ */
+u8 execute_entry_hazards();
+
+/**
+ * @brief execute a lay script for entry hazards
+ * @return true
+ */
+u8 lay_entry_hazards();
+
+/* === IMPLEMENTATIONS === */
 u8 execute_entry_hazards() {
     u8 active_side = get_side_from_bank(battle_active_bank);
     u8 has_effect = 0;
@@ -47,7 +98,7 @@ u8 execute_entry_hazards() {
         active_side_affecting->stealth_rock_done = 1;
         //check for magic guard here
         u32 damage = battle_participants[battle_active_bank].max_hp;
-        switch (type_effectiveness_calc(MOVE_STEALTH_ROCK, TYPE_ROCK, battle_active_bank^1, battle_active_bank, 0) >> 4) {
+        switch (battle_type_effectiveness_calc(MOVE_STEALTH_ROCK, TYPE_ROCK, battle_active_bank^1, battle_active_bank, 0) >> 4) {
             case 1:
                 damage = damage >> 5;
                 break;
@@ -73,13 +124,13 @@ u8 execute_entry_hazards() {
         has_effect = 1;
     } else if (active_side_affecting->toxic_spikes_psn && !(active_side_affecting->toxic_spikes_done)) {
         active_side_affecting->toxic_spikes_done = 1;
-        if (has_type(battle_active_bank, TYPE_POISON)) {
+        if (battle_bank_has_type(battle_active_bank, TYPE_POISON)) {
             has_effect = 1;
             active_side_affecting->toxic_spikes_psn = 0;
             active_side_affecting->toxic_spikes_badpsn = 0;
             battle_script_push();
             battlescript_cursor = bs_toxic_resolve;
-        } else if (!cant_poison(battle_active_bank, 0)) {
+        } else if (!battle_bank_is_poison_resistant(battle_active_bank, 0)) {
             if (active_side_affecting->toxic_spikes_badpsn) {
                 battle_participants[battle_active_bank].status.flags.toxic_poison = 1;
                 battle_script_push();

src/debug/debug.c

@@ -39,30 +39,22 @@
 #include <math.h>
 #include <fade.h>
 
-/* === STATICS === */
+/* === STRUCTURES === */
+
+struct assert_memory
+{
+    char* file;
+    int line;
+    char* expression;
+};
 
+/* === STATICS === */
+struct assert_memory* assert_global = (struct assert_memory*)0x0203FEC4;
 static struct print_engine* print_memory = (struct print_engine*)(0x0203FFF0);
 
 /* === PROTOTYPES === */
 
 /**
- * @brief set bg color
- * @param color color to set bg to
- */
-void debug_set_bg(u16 color);
-
-/**
- * @brief clean debug screen from any text and reset cursor
- */
-void debug_clean();
-
-/**
- * @brief wait for button press
- * @param field bitfield to specify buttom combination
- */
-void debug_wait_for_btn(u16 field);
-
-/**
  * @brief convert int to char
  * @param i integer
  * @param ref buffer to output to
@@ -122,12 +114,6 @@ void debug_print_char(u16 line, u16 row, char character, u8 color);
 void debug_print_string(u16 line, u16 row, u8 color, char* pBuf);
 
 /**
- * @brief print string onto debug environment at current position with parsing
- * @param str string to print
- */
-void debug_print(char* str);
-
-/**
  * @brief build power
  * @param n integer to power
  * @param power exponent
@@ -135,12 +121,8 @@ void debug_print(char* str);
  */
 u32 debug_power(u32 n, u32 power);
 
-/**
- * @brief print in format to debug environment
- * @param str string with format
- * @param arg argument to print (only one, not an array)
- */
-void debug_printf(char* str, int arg);
+void debug_init_stage_one();
+void debug_init_stage_two();
 
 /**
  * @brief set bg color of debug environment
@@ -152,34 +134,34 @@ void debug_set_bg(u16 color) {
     return;
 }
 
+/* === STATIC STRUCTURES === */
+
+static struct bg_config debug_bg_config[4] = {
+    {0, 0, 0x19, 0, 0, 0},
+    {1, 1, 0x1A, 0, 0, 1},
+    {2, 2, 0x1B, 0, 0, 2},
+    {3, 3, 0x1C, 0, 0, 3}
+};
+
 /* === IMPLEMENTATIONS === */
+
+void as_assert(char* expression, char* file, int line)
+{
+    assert_global->file = file;
+    assert_global->line = line;
+    assert_global->expression = expression;
+    
+    set_callback2(debug_assert_scene);
+    vblank_handler_set(debug_update);
+    superstate.multi_purpose_state_tracker = 0;
+}
+
 void debug_scene() {
     if (superstate.multi_purpose_state_tracker == 0) {
-        print_memory->row = 0;
-        print_memory->line = 0;
-        print_memory->color = 0;
-        gpu_tile_bg_drop_all_sets(0);
-        gpu_tile_bg_drop_all_sets(1);
-        gpu_tile_bg_drop_all_sets(2);
-        gpu_tile_bg_drop_all_sets(3);
-
-        gpu_bg_vram_setup(0, standard_bg, 4);
-
-        gpu_bg_show(0);
-        gpu_bg_show(1);
-        gpu_bg_show(2);
-        gpu_bg_show(3);
-
-        gpu_sync_bg_visibility_and_mode();
-        debug_reset_scrolling();
-        obj_delete_all();
-        memset((void*) 0x06000000, 0, 0x17fe0);
-        memset((void*) 0x020375F8, 0, 0x400);
+        debug_init_stage_one();
         superstate.multi_purpose_state_tracker++;
     } else if (superstate.multi_purpose_state_tracker == 1) {
-        vram_decompress((void*) asciiTiles, (void*) 0x06000000);
-        memcpy((void*) 0x020375F8, (void*) asciiPal, 0x60);
-        debug_set_bg(0x0000);
+        debug_init_stage_two();
         superstate.multi_purpose_state_tracker++;
     } else if (superstate.multi_purpose_state_tracker == 2) {
         debug_init_unit_test();
@@ -188,12 +170,12 @@ void debug_scene() {
     return;
 }
 
-u8 debug_some_test() {
+void debug_some_test() {
     set_callback2(debug_scene);
     vblank_handler_set(debug_update);
     superstate.multi_purpose_state_tracker = 0;
-
-    return 0;
+    
+    return;
 }
 
 void debug_reset_scrolling() {
@@ -221,10 +203,15 @@ void debug_print_string(u16 line, u16 row, u8 color, char* pBuf) {
 
 void debug_print(char* str) {
     while (*str) {
+        if(print_memory->row > 29)
+        {
+            print_memory->line++;
+            print_memory->row = 0;
+        }
         if (*str == '\n') {
             print_memory->line++;
             print_memory->row = 0;
-        } else if (*str == '\xFE') {
+        } if (*str == '\xFE') {
             str++;
             u8 c = *str;
             if (c > 2)
@@ -241,10 +228,15 @@ void debug_print(char* str) {
 
 void debug_printf(char* str, int arg) {
     while (*str) {
+        if(print_memory->row > 29)
+        {
+            print_memory->line++;
+            print_memory->row = 0;
+        }
         if (*str == '\n') {
             print_memory->line++;
             print_memory->row = 0;
-        } else if (*str == '\xFE') {
+        } if (*str == '\xFE') {
             str++;
             u8 c = *str;
             if (c > 2)
@@ -289,6 +281,56 @@ void debug_wait_for_btn(u16 field) {
     return;
 }
 
+void debug_init_stage_one()
+{
+    print_memory->row = 0;
+    print_memory->line = 0;
+    print_memory->color = 0;
+    gpu_tile_bg_drop_all_sets(0);
+    gpu_tile_bg_drop_all_sets(1);
+    gpu_tile_bg_drop_all_sets(2);
+    gpu_tile_bg_drop_all_sets(3);
+
+    gpu_bg_vram_setup(0, debug_bg_config, 4);
+
+    gpu_bg_show(0);
+    gpu_bg_show(1);
+    gpu_bg_show(2);
+    gpu_bg_show(3);
+
+    gpu_sync_bg_visibility_and_mode();
+    debug_reset_scrolling();
+    obj_delete_all();
+    memset((void*) 0x06000000, 0, 0x17fe0);
+    memset((void*) 0x020375F8, 0, 0x400);
+}
+
+void debug_init_stage_two()
+{
+    vram_decompress((void*) asciiTiles, (void*) 0x06000000);
+    memcpy((void*) 0x020375F8, (void*) asciiPal, 0x60);
+    debug_set_bg(0x0000);
+}
+
+void debug_assert_scene() {
+    if (superstate.multi_purpose_state_tracker == 0) {
+        debug_init_stage_one();
+        superstate.multi_purpose_state_tracker++;
+    } else if (superstate.multi_purpose_state_tracker == 1) {
+        debug_init_stage_two();
+        superstate.multi_purpose_state_tracker++;
+    } else if (superstate.multi_purpose_state_tracker == 2) {
+        debug_print("Assertion Failed: ");
+        debug_print(assert_global->expression);
+        debug_print("\n\nFile: ");
+        debug_print(assert_global->file);
+        debug_printf("\n\nLine: %d", assert_global->line);
+        superstate.multi_purpose_state_tracker++;
+    }
+    /* Loop Endlessly in this stage */
+    return;
+}
+
 void debug_print_char(u16 line, u16 row, char character, u8 color) {
     if (color > 2)
         color = 0;

src/dns/dns_core.c

@@ -1,7 +1,160 @@
-#include <bpre.h>
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file dns_core.c
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief interact with the dns system
+ *
+ */
+
+/* === INCLUDE === */
 #include <dns_core.h>
 #include <memory.h>
+#include <lcd.h>
+#include <callback.h>
+
+/* === PROTOTYPES === */
+
+/**
+ * @brief hacked overworld callback to update palettes
+ */
+void dns_cb_overworld_hacked();
+
+/**
+ * @brief get current time of day type
+ * @return enum containing respective day type
+ */
+enum dns_rtc_time_type dns_get_time_of_day();
+
+/**
+ * @brief load virtual pal of npc
+ * @param dst destination to load to
+ * @param tag tag to load
+ * @param slot slot to load
+ * @param shade shade immediatly if true
+ */
+void dns_npc_load_virtual_pal(struct color* dst, u16 tag, u8 slot, u8 shade);
+
+/**
+ * @brief allocate a virtual pal and load it
+ * @return pointer to allocated color array
+ */
+struct color* dns_alloc_virtual_pal_and_load();
+
+/**
+ * @brief update palettes
+ */
+void dns_update_palettes();
+
+/**
+ * @brief load pal of overworld animation i.e. grass
+ * @param oe_script_pointer pointer to oe_script controlling the animation
+ */
+void dns_overworld_anim_load_pal(void** oe_script_pointer);
+
+/**
+ * @brief load blockset to virtual space
+ * @param blockset pointer to blockset to load
+ * @param start start range
+ * @param len end range
+ * @param destination virtual destination to load to
+ */
+void dns_blockset_load_virtual_palette_and_shade(struct blockset* blockset, u16 start, u16 len, struct color* destination);
+
+/**
+ * @brief load blockset into palram and shade it
+ * @param blockset pointer to blockset to load
+ * @param start start range
+ * @param len end range
+ */
+void dns_blockset_load_palette_to_gpu_and_shade(struct blockset* blockset, u16 start, u16 len);
+
+/**
+ * @brief load second pal of mapheader given
+ * @param data_header pointer to mapdata header
+ */
+void dns_mapdata_load_palette_two(struct mapdata_header* data_header);
+
+/**
+ * @brief load second pal of mapheader given
+ * @param data_header pointer to mapdata header
+ */
+void dns_mapdata_load_palette_one(struct mapdata_header* data_header);
 
+/**
+ * @brief apply light effects to given color array
+ * @param blockset pointer to blockset
+ * @param secondary is the blockset a secondary blockset
+ * @param buffer color buffer to apply lighting to
+ */
+void dns_apply_lighting(void* blockset, u8 secondary, struct color* buffer);
+
+/**
+ * @brief apply shaders to color buffer
+ * @param pal pal to apply shader to
+ * @param fade_copy copy to unfaded immediatly if true
+ * @param buffer color buffer
+ */
+void dns_apply_shaders(u8 pal, u8 fade_copy, struct color* buffer);
+
+/**
+ * @brief copy slot to faded buffer
+ * @param slot palette slot
+ */
+void dns_copy_unfaded(u8 slot);
+
+/**
+ * @brief should the map allow shading?
+ * @param current_type maptype to check for
+ * @return 
+ */
+u8 dns_should_shade(enum map_type current_type);
+
+/**
+ * @brief get color shade struct from time of day
+ * @param current_time current time of day
+ * @return color_shade struct with respective information
+ */
+struct color_shade dns_get_shade_from_time(enum dns_rtc_time_type current_time);
+
+/**
+ * @brief blend color a over color b
+ * @param a first color
+ * @param b second color
+ * @param alpha alpha value
+ * @return blended color
+ */
+struct color dns_alpha_blend(struct color a, struct color b, u8 alpha);
+
+/**
+ * @brief patch hack for npc and pal slot
+ * @param tag tag to apply hack to
+ * @param pal_slot pal slot to apply hack to
+ */
+void dns_pal_patch_for_npc(u16 tag, u8 pal_slot);
+
+/* === STATICS === */
 
 static struct pal_replace lightmap[] = {
     {(void*) 0x082D4AAC, 9, 10, {
@@ -19,7 +172,24 @@ static struct pal_replace lightmap[] = {
         }}
 };
 
-void overworld_loop() {
+static struct color_shade color_shade_day = {
+    {0, 0, 0}, 255
+};
+static struct color_shade color_shade_night = {
+    {0, 6, 16}, 120
+};
+
+static struct color_shade color_shade_evening = {
+    {12, 7, 17}, 120
+};
+
+static struct color_shade color_shade_morning = {
+    {6, 16, 6}, 150
+};
+
+/* === IMPLEMENTATIONS === */
+
+void dns_cb_overworld_hacked() {
     script_something();
     task_exec();
     objc_exec();
@@ -33,80 +203,65 @@ void overworld_loop() {
 
     volatile u8* test_pointer = (u8*) (0x0203FAB0);
     if (*test_pointer == 1 && (fade_controller.mix_color & 0x8000) == 0) {
-        update_dns_palettes();
+        dns_update_palettes();
         *test_pointer = 0;
     }
 }
 
-enum time_type get_time_of_day() {
+enum dns_rtc_time_type dns_get_time_of_day() {
     volatile u8* time_pointer = (u8*) (0x0203FAB1);
     return *time_pointer;
 }
 
-static struct color_shade color_shade_day = {
-    {0, 0, 0}, 255
-};
-static struct color_shade color_shade_night = {
-    {0, 6, 16}, 120
-};
-
-static struct color_shade color_shade_evening = {
-    {12, 7, 17}, 120
-};
-
-static struct color_shade color_shade_morning = {
-    {6, 16, 6}, 150
-};
-
-void npc_load_virtual_pal(struct color* dst, u16 tag, u8 slot, u8 shade) {
+void dns_npc_load_virtual_pal(struct color* dst, u16 tag, u8 slot, u8 shade) {
     u16 npc_map_entry = npc_pal_idx_for_given_tag(tag);
     memcpy(dst + (16 + slot)*16, npc_palettes[npc_map_entry].palette, 32);
     if (shade) {
         tint_palette(slot);
-        apply_shaders(slot + 16, 0, dst);
+        dns_apply_shaders(slot + 16, 0, dst);
     }
 }
 
 struct color* dns_alloc_virtual_pal_and_load() {
     struct color* destination = malloc(0x400);
-    blockset_load_virtual_palette_and_shade(current_mapheader.data_header->blockset_one, 0x0, 0xE0, destination);
-    blockset_load_virtual_palette_and_shade(current_mapheader.data_header->blockset_two, 0x70, 0xC0, destination);
+    dns_blockset_load_virtual_palette_and_shade(current_mapheader.data_header->blockset_one, 0x0, 0xE0, destination);
+    dns_blockset_load_virtual_palette_and_shade(current_mapheader.data_header->blockset_two, 0x70, 0xC0, destination);
     
-    npc_load_virtual_pal(destination, 0x1120, 0, false);
+    dns_npc_load_virtual_pal(destination, 0x1120, 0, false);
     load_palette_3(0x0, 0xD0);
     for (int i = 0; i < 16; ++i) {
         if (dynamic_palettes[i].tag >= 0x1100) {
-            npc_load_virtual_pal(destination, dynamic_palettes[i].tag, i, true);
+            dns_npc_load_virtual_pal(destination, dynamic_palettes[i].tag, i, true);
         } else if (dynamic_palettes[i].tag == 0x1004) {
             //oe_0001
             struct color* oe_pal_1 = (struct color*) (0x08398FA8);
             memcpy(destination + (16 + i) * 16, oe_pal_1, 32);
-            apply_shaders(16 + i, 0, destination);
+            dns_apply_shaders(16 + i, 0, destination);
 
         } else if (dynamic_palettes[i].tag == 0x1005) {
             //oe_0002
             struct color* oe_pal_2 = (struct color*) (0x08398FC8);
             memcpy(destination + (16 + i) * 16, oe_pal_2, 32);
-            apply_shaders(16 + 1, 0, destination);
+            dns_apply_shaders(16 + 1, 0, destination);
         }
     }
     return destination;
 }
 
-void update_dns_palettes() {
+void dns_update_palettes() {
     struct color* destination = dns_alloc_virtual_pal_and_load();
     gpu_pal_apply(destination, 0x0, 0x1A0);
     gpu_pal_apply(destination + 0x100, 0x100, 0x200);
     free(destination);
 }
 
-void overworld_anim_load_pal(void** oe_script_pointer) {
+void dns_overworld_anim_load_pal(void** oe_script_pointer) {
     struct npc_palette* pal_to_apply = oe_read_word(oe_script_pointer);
     u16 current_idx = gpu_pal_tags_index_of(pal_to_apply->tag);
 
     struct color* temp_color = malloc(32);
     memcpy(temp_color, pal_to_apply->palette, 32);
-    apply_shaders(0, 0, temp_color);
+    dns_apply_shaders(0, 0, temp_color);
 
     struct obj_resource temp_resource = {temp_color, pal_to_apply->tag, pal_to_apply->fill};
     obj_gpu_pal_alloc_tag_and_apply(&temp_resource);
@@ -121,15 +276,15 @@ void overworld_anim_load_pal(void** oe_script_pointer) {
     return;
 }
 
-void blockset_load_virtual_palette_and_shade(struct blockset* blockset, u16 start, u16 len, struct color* destination) {
+void dns_blockset_load_virtual_palette_and_shade(struct blockset* blockset, u16 start, u16 len, struct color* destination) {
     if (blockset == 0)
         return;
     if (blockset->is_secondary) {
         if (blockset->is_secondary == 1) {
             memcpy(destination + start, blockset->palette + (start * 2), len);
             for (u8 i = 7; i < 7 + 6; ++i)
-                apply_shaders(i, 0, destination);
-            apply_lighting(blockset, 0, destination);
+                dns_apply_shaders(i, 0, destination);
+            dns_apply_lighting(blockset, 0, destination);
             //gpu_pal_apply((color_memory), start, len);
             //load_palette_3(start, len >> 1);
         } else {
@@ -137,8 +292,8 @@ void blockset_load_virtual_palette_and_shade(struct blockset* blockset, u16 star
             lz77u_wram(blockset->palette, pal_buffer);
             memcpy(destination + start, pal_buffer + (start * 2), len);
             for (u8 i = 7; i < 7 + 6; ++i)
-                apply_shaders(i, 0, destination);
-            apply_lighting(blockset, 0, destination);
+                dns_apply_shaders(i, 0, destination);
+            dns_apply_lighting(blockset, 0, destination);
             //gpu_pal_apply(pal_buffer, start, len);
             //load_palette_3(start, len >> 1);
         }
@@ -146,8 +301,8 @@ void blockset_load_virtual_palette_and_shade(struct blockset* blockset, u16 star
         //struct color* color_memory = malloc(224);
         memcpy(destination, blockset->palette, len);
         for (u8 i = 0; i < 7; ++i)
-            apply_shaders(i, 0, destination);
-        apply_lighting(blockset, 0, destination);
+            dns_apply_shaders(i, 0, destination);
+        dns_apply_lighting(blockset, 0, destination);
         //gpu_pal_apply(color_memory, start, len);
         //load_palette_3(start, len >> 1);
         //free(color_memory);
@@ -155,7 +310,7 @@ void blockset_load_virtual_palette_and_shade(struct blockset* blockset, u16 star
     return;
 }
 
-void blockset_load_palette_to_gpu_and_shade(struct blockset* blockset, u16 start, u16 len) {
+void dns_blockset_load_palette_to_gpu_and_shade(struct blockset* blockset, u16 start, u16 len) {
     if (blockset == 0)
         return;
     if (blockset->is_secondary) {
@@ -163,8 +318,8 @@ void blockset_load_palette_to_gpu_and_shade(struct blockset* blockset, u16 start
             struct color* color_memory = malloc(224);
             memcpy(color_memory, blockset->palette + 0xE0, 224);
             for (u8 i = 0; i < 7; ++i)
-                apply_shaders(i, 0, color_memory);
-            apply_lighting(blockset, 1, color_memory);
+                dns_apply_shaders(i, 0, color_memory);
+            dns_apply_lighting(blockset, 1, color_memory);
             gpu_pal_apply((color_memory), start, len);
             load_palette_3(start, len >> 1);
             free(color_memory);
@@ -172,8 +327,8 @@ void blockset_load_palette_to_gpu_and_shade(struct blockset* blockset, u16 start
             struct color* pal_buffer = (struct color*) (0x02037ACC);
             lz77u_wram(blockset->palette, pal_buffer);
             for (u8 i = 7; i < 7 + 6; ++i)
-                apply_shaders(i, 0, pal_buffer);
-            apply_lighting(blockset, 0, pal_buffer);
+                dns_apply_shaders(i, 0, pal_buffer);
+            dns_apply_lighting(blockset, 0, pal_buffer);
             gpu_pal_apply(pal_buffer, start, len);
             load_palette_3(start, len >> 1);
         }
@@ -181,8 +336,8 @@ void blockset_load_palette_to_gpu_and_shade(struct blockset* blockset, u16 start
         struct color* color_memory = malloc(224);
         memcpy(color_memory, blockset->palette, 224);
         for (u8 i = 0; i < 7; ++i)
-            apply_shaders(i, 0, color_memory);
-        apply_lighting(blockset, 0, color_memory);
+            dns_apply_shaders(i, 0, color_memory);
+        dns_apply_lighting(blockset, 0, color_memory);
         gpu_pal_apply(color_memory, start, len);
         load_palette_3(start, len >> 1);
         free(color_memory);
@@ -190,27 +345,27 @@ void blockset_load_palette_to_gpu_and_shade(struct blockset* blockset, u16 start
     return;
 }
 
-void mapdata_load_palette_two(struct mapdata_header* data_header) {
+void dns_mapdata_load_palette_two(struct mapdata_header* data_header) {
     //struct color* destination = malloc(0x200);
     //blockset_load_virtual_palette_and_shade(data_header->blockset_two, 0x70, 0xC0, destination);
     //gpu_pal_apply(destination, 0x70, 0xC0);
     //load_palette_3(0x70, 0xC0 >> 1);
-    blockset_load_palette_to_gpu_and_shade(data_header->blockset_two, 0x70, 0xC0);
+    dns_blockset_load_palette_to_gpu_and_shade(data_header->blockset_two, 0x70, 0xC0);
     return;
 }
 
-void mapdata_load_palette_one(struct mapdata_header* data_header) {
+void dns_mapdata_load_palette_one(struct mapdata_header* data_header) {
     //struct color* destination = malloc(0x200);
     //blockset_load_virtual_palette_and_shade(data_header->blockset_one, 0x0, 0xE0, destination);
     //gpu_pal_apply(destination, 0x0, 0xE0);
     //load_palette_3(0x0, 0xE0 >> 1);
 
-    blockset_load_palette_to_gpu_and_shade(data_header->blockset_one, 0x0, 0xE0);
+    dns_blockset_load_palette_to_gpu_and_shade(data_header->blockset_one, 0x0, 0xE0);
     return;
 }
 
-void apply_lighting(void* blockset, u8 secondary, struct color* buffer) {
-    if (get_time_of_day() != NIGHT)
+void dns_apply_lighting(void* blockset, u8 secondary, struct color* buffer) {
+    if (dns_get_time_of_day() != NIGHT)
         return;
     for (int i = 0; i < (sizeof (lightmap) / sizeof (lightmap[0])); ++i) {
         if (blockset == lightmap[i].blockset) {
@@ -220,26 +375,26 @@ void apply_lighting(void* blockset, u8 secondary, struct color* buffer) {
     return;
 }
 
-void apply_shaders(u8 pal, u8 fade_copy, struct color* buffer) {
+void dns_apply_shaders(u8 pal, u8 fade_copy, struct color* buffer) {
     if (tint_filter != 0)
         return;
-    if (!is_current_map_dn_valid(current_mapheader.maptype))
+    if (!dns_should_shade(current_mapheader.maptype))
         return;
     for (int i = pal * 16; i < (pal * 16) + 16; ++i) {
-        struct color_shade current_shade = get_color_from_time(get_time_of_day());
-        buffer[i] = alpha_blend(buffer[i], current_shade.color, current_shade.alpha);
+        struct color_shade current_shade = dns_get_shade_from_time(dns_get_time_of_day());
+        buffer[i] = dns_alpha_blend(buffer[i], current_shade.color, current_shade.alpha);
     }
     if (fade_copy)
-        copy_unfaded(pal);
+        dns_copy_unfaded(pal);
 }
 
-void copy_unfaded(u8 slot) {
+void dns_copy_unfaded(u8 slot) {
     for (int i = slot * 16; i < (slot * 16) + 16; ++i) {
         palette_faded_buffer[i] = palette_unfaded_buffer[i];
     }
 }
 
-u8 is_current_map_dn_valid(enum map_type current_type) {
+u8 dns_should_shade(enum map_type current_type) {
     switch (current_type) {
         case VILLAGE:
         case CITY:
@@ -251,7 +406,7 @@ u8 is_current_map_dn_valid(enum map_type current_type) {
     return 0;
 }
 
-struct color_shade get_color_from_time(enum time_type current_time) {
+struct color_shade dns_get_shade_from_time(enum dns_rtc_time_type current_time) {
     switch (current_time) {
         case NIGHT:
             return color_shade_night;
@@ -266,7 +421,7 @@ struct color_shade get_color_from_time(enum time_type current_time) {
     }
 }
 
-struct color alpha_blend(struct color a, struct color b, u8 alpha) {
+struct color dns_alpha_blend(struct color a, struct color b, u8 alpha) {
     if (alpha == 255)
         return a;
     if (alpha == 0)
@@ -280,10 +435,11 @@ struct color alpha_blend(struct color a, struct color b, u8 alpha) {
     return output;
 }
 
-void pal_patch_for_npc(u16 tag, u8 pal_slot) {
+
+void dns_pal_patch_for_npc(u16 tag, u8 pal_slot) {
     u16 npc_map_entry = npc_pal_idx_for_given_tag(tag);
     gpu_pal_apply(npc_palettes[npc_map_entry].palette, (pal_slot + 16) * 16, 32);
     tint_palette(pal_slot);
-    apply_shaders(pal_slot + 16, 1, palette_unfaded_buffer);
+    dns_apply_shaders(pal_slot + 16, 1, palette_unfaded_buffer);
 }
 /*use fade in animation, load palettes according to current fade state*/

src/encode/crc32.c

@@ -1,6 +1,51 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file crc32.c
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief cyclic redundancy check algorithm
+ *
+ */
+
+
+/* === INCLUDE === */
 #include <config.h>
 #include <types.h>
 
+/* === PROTOTYPES === */
+
+/**
+ * @brief performs crc32 on data in buf
+ * @param crc starting value
+ * @param buf data buffer 
+ * @param size data size
+ * @return crc32
+ */
+u32 crc32(u32 crc, const void *buf, u32 size);
+
+/* === STATICS === */
+
 static u32 crc32_tab[] = {
 	0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
 	0xe963a535, 0x9e6495a3,	0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,

src/include/attack_names.h

@@ -1,3 +1,32 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file attack_names.h
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Abilities in Assembler notation
+ */
+
 .equ ABSORB, 0x47
 .equ ACID, 0x33
 .equ ACID_ARMOR, 0x97

src/include/battle.h

@@ -1,34 +0,0 @@
-#include <battle_structs.h>
-#include <custom_structs.h>
-#include <battle_locations.h>
-#include <pkmn_types.h>
-#include <abilities.h>
-#include <moves.h>
-#include <item_effects.h>
-#include <items.h>
-#include <pokemon.h>
-#include <battle_abilities.h>
-
-#ifndef BATTLE_H_
-#define BATTLE_H_
-
-#define REQUEST_HELDITEM_BATTLE 0x2
-#define REQUEST_STATUS_BATTLE 0x28
-
-struct stat_fractions{
-    u8 dividend;
-    u8 divisor;
-};
-
-struct stat_fractions stat_buffs[] = { {2, 8}, {2, 7}, {2, 6}, {2, 5}, {2, 4}, {2, 3}, {2, 2}, {3, 2}, {4, 2}, {5, 2}, {6, 2}, {7, 2}, {8, 2} };
-
-u8 get_side_from_bank(u8 bank);
-u16 battle_turn_random;
-
-void mark_buffer_bank_for_execution(u8 bank);
-void prepare_setattributes_in_battle(u8 buffer, u8 data_request, u8 unkown, u8 data_to_add, void* ptr_to_attribute);
-u8 item_get_quality(u8 item_id);
-u8 get_item_x12_battle_function(u16 item_id);
-void battle_script_push();
-
-#endif

src/include/battle_abilities.h

@@ -1,11 +1,61 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file battle_abilities.h
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Some methods concerning in-battle abilities
+ */
+
 #ifndef BATTLE_ABILITIES_H
 #define BATTLE_ABILITIES_H
 
-#include <bpre.h>
+/* === INCLUDES === */
+
+#include <types.h>
+
+/**
+ * @brief checks if ability is blocked
+ * @param bank bank to check for
+ * @param mold_breaker check for mold breaker?
+ * @param gastro check for gastro acid?
+ * @return true if the ability has an effect, false otherwise.
+ */
+u8 ability_has_effect(u8 bank, u8 mold_breaker, u8 gastro);
+
+/**
+ * @brief do weather abilities have an effect?
+ * @return false if weather abilities are blocked, true otherwise
+ */
+u8 ability_weather_effects();
 
-u8 has_ability_effect(u8 bank, u8 mold_breaker, u8 gastro);
-u8 weather_abilities_effect();
-u8 has_ability(u8 bank, u8 ability);
+/**
+ * @brief has bank ability
+ * @param bank bank to check
+ * @param ability ability to check for
+ * @return true if bank has ability, false otherwise
+ */
+u8 ability_has_ability(u8 bank, u8 ability);
 
 #endif /* BATTLE_ABILITIES_H */
 

src/include/battle_common.h

@@ -0,0 +1,17 @@
+#ifndef BATTLE_H_
+#define BATTLE_H_
+
+#include <types.h>
+
+#define REQUEST_HELDITEM_BATTLE 0x2
+#define REQUEST_STATUS_BATTLE 0x28
+
+u8 get_side_from_bank(u8 bank);
+u16 battle_turn_random;
+void mark_buffer_bank_for_execution(u8 bank);
+void prepare_setattributes_in_battle(u8 buffer, u8 data_request, u8 unkown, u8 data_to_add, void* ptr_to_attribute);
+u8 item_get_quality(u8 item_id);
+u8 get_item_x12_battle_function(u16 item_id);
+void battle_script_push();
+
+#endif

src/include/battle_fractions.h

@@ -0,0 +1,12 @@
+#ifndef BATTLE_FRACTIONS_H
+#define BATTLE_FRACTIONS_H
+
+struct stat_fractions{
+    u8 dividend;
+    u8 divisor;
+};
+
+struct stat_fractions stat_buffs[] = { {2, 8}, {2, 7}, {2, 6}, {2, 5}, {2, 4}, {2, 3}, {2, 2}, {3, 2}, {4, 2}, {5, 2}, {6, 2}, {7, 2}, {8, 2} };
+
+#endif /* BATTLE_FRACTIONS_H */
+

src/include/battle_help.h

@@ -1,13 +1,100 @@
-#include <battle.h>
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file battle_help.h
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Some helper methods to calculate in-battle outcomes etc.
+ */
 
 #ifndef BATTLE_HELP_H_
 #define BATTLE_HELP_H_
 
-u8 get_item_effect(u8 bank, u8 check_negating_effects);
-u16 damage_type_effectiveness_update(u8 attacking_type, u8 defending_type, u8 atk_bank, u8 def_bank, u16 chained_effect, u8 airstatus);
-u16 apply_type_effectiveness(u16 chained_effect, u8 move_type, u8 target_bank, u8 atk_bank, u8 airstatus);
-u16 type_effectiveness_calc(u16 move, u8 move_type, u8 atk_bank, u8 def_bank, u8 effects_handling_and_recording);
-u8 has_type(u8 bank, u8 type);
-u8 cant_poison(u8 bank, u8 self_inflicted);
-u8 count_party_pokemon(u8 bank);
+#include <types.h>
+
+/**
+ * @brief get item effect of bank
+ * @param bank bank to check effect
+ * @param check_negating_effects if true only return effect if it can be executed
+ * @return item effect of item held by bank
+ */
+u8 battle_item_get_effect(u8 bank, u8 check_negating_effects);
+
+/**
+ * @brief update the chained effectiveness according to parameters
+ * @param attacking_type type of attacking move
+ * @param defending_type type of defender
+ * @param atk_bank bank of attacker
+ * @param def_bank bank of defender
+ * @param chained_effect previously chained effect
+ * @param airstatus airborne status according to enumeration
+ * @return new chained effect
+ */
+u16 battle_damage_type_effectiveness_update(u8 attacking_type, u8 defending_type, u8 atk_bank, u8 def_bank, u16 chained_effect, u8 airstatus);
+
+/**
+ * @brief fully calculate effectiveness from a base effectiveness (def: 64)
+ * @param chained_effect chained input (def: 64)
+ * @param move_type attacking move type
+ * @param target_bank bank of target
+ * @param atk_bank bank of attacker
+ * @param airstatus airstatus of defender
+ * @return chained effectiveness
+ */
+u16 battle_apply_type_effectiveness(u16 chained_effect, u8 move_type, u8 target_bank, u8 atk_bank, u8 airstatus);
+
+/**
+ * @brief calculate type effectiveness from front to back
+ * @param move executed move
+ * @param move_type type of executed move according to type enumeration
+ * @param atk_bank bank of attacker
+ * @param def_bank bank of defender
+ * @param effects_handling_and_recording TO BE DONE
+ * @return effectiveness of made attack
+ */
+u16 battle_type_effectiveness_calc(u16 move, u8 move_type, u8 atk_bank, u8 def_bank, u8 effects_handling_and_recording);
+
+/**
+ * @brief has bank type
+ * @param bank bank to check
+ * @param type type to check for
+ * @return true if bank has type, false otherwise
+ */
+u8 battle_bank_has_type(u8 bank, u8 type);
+
+/**
+ * @brief check if bank is resistant to poison
+ * @param bank bank to check for
+ * @param self_inflicted was poison self_inflicted?
+ * @return 0 if pokemon can be poisoned; 1 if already poisoned; 2 if other status condition e.g. burn; 3 if blocked by type; 4 if blocked by ability; 5 if blocked by safeguard; 6 if blocked by misty terrain (TODO)
+ * 
+ */
+u8 battle_bank_is_poison_resistant(u8 bank, u8 self_inflicted);
+
+/**
+ * @brief counts usable party pokemon of side from bank
+ * @param bank bank of which usable pokemon should be counted
+ * @return usable (not dead) pokemon on side from bank
+ */
+u8 battle_count_party_pokemon(u8 bank);
 #endif

src/include/battle_initiative.h

@@ -1,11 +1,57 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file battle_initiative.h
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Methods calculating speed based stats in-battle
+ */
+
 #ifndef BATTLE_INITIATIVE_H
 #define BATTLE_INITIATIVE_H
 
+/* === INCLUDES === */
 #include <types.h>
 
+/* === ENUMERATIONS === */
 enum init_enum {ONE, TWO, TIE};
 
+/* === PROTOTYPES === */
+
+/**
+ * @brief calculate who strikes first
+ * @param bank1 first contrahend
+ * @param bank2 second contrahend
+ * @param ignore_prio ignore priority of moves
+ * @return bank to strike first as described in enumeration
+ */
 enum init_enum get_first_to_strike(u8 bank1, u8 bank2, u8 ignore_prio);
+
+/**
+ * @brief get the (modified) speed of bank
+ * @param bank bank to get speed of
+ * @return modified speed value of pokemon in bank
+ */
 u16 get_speed(u8 bank);
 #endif /* BATTLE_INITIATIVE_H */
 

src/include/battle_locations.h

@@ -1,6 +1,38 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file attack_names.h
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Some globals used in-battle
+ */
+
+
 #ifndef BATTLE_LOC_H_
 #define BATTLE_LOC_H_
 
+#include <types.h>
+
 u8 battle_active_bank;
 u8 battle_stat_changer;
 void* battle_string_chooser;

src/include/battle_script.h

@@ -1,3 +1,33 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by KDS                                           *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file battle_script.h
+ * @author KDS
+ * @date 15 dec 2016
+ * @brief Preprocessor Macros for writing PKMN Battle Scripts
+ */
+
+
 #include <attack_names.h>
 
 @@ Banks
@@ -60,7 +90,6 @@
 .byte 4
 .endm
 
-
 .macro cmd5
 .byte 5
 .endm

src/include/debug.h

@@ -1,13 +1,88 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file debug.h
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Operate with the sots debug engine, very temporary
+ */
+
 #ifndef DEBUG_H
 #define DEBUG_H
 
+/* === MACROS === */
+#define STRINGIFY(x) #x
+#define TOSTRING(x) STRINGIFY(x)
+#define assert(EX)  if(!EX) {as_assert(STRINGIFY(EX), __FILE__, __LINE__);}
+
 struct print_engine{
+    
     u8 line;
     u8 row;
     u8 color;
 };
 
-u8 debug_some_test();
+/**
+ * @brief temporary method to initiate a debug process / unit test
+ */
+void debug_some_test();
+
+/**
+ * @brief set bg color
+ * @param color color to set bg to
+ */
+void debug_set_bg(u16 color);
+
+/**
+ * @brief clean debug screen from any text and reset cursor
+ */
+void debug_clean();
+
+/**
+ * @brief print string onto debug environment at current position with parsing
+ * @param str string to print
+ */
+void debug_print(char* str);
+
+/**
+ * @brief wait for button press
+ * @param field bitfield to specify buttom combination
+ */
+void debug_wait_for_btn(u16 field);
+
+/**
+ * @brief print in format to debug environment
+ * @param str string with format
+ * @param arg argument to print (only one, not an array)
+ */
+void debug_printf(char* str, int arg);
+
+/**
+ * @brief handle for the assert scene
+ */
+void debug_assert_scene();
+
+void as_assert(char* expression, char* file, int line);
 
 #endif /* DEBUG_H */
 

src/include/dns_core.h

@@ -1,7 +1,12 @@
 #ifndef DNS_CORE_H
 #define DNS_CORE_H
 
-enum time_type {
+#include <types.h>
+#include <lcd.h>
+#include <objects.h>
+#include <fade.h>
+
+enum dns_rtc_time_type {
     DAY,
     NIGHT,
     EVENING,
@@ -89,31 +94,22 @@ struct dynamic_pal {
 
 #define dynamic_palettes ((struct dynamic_pal*) 0x0203FF00)
 
-void blockset_load_virtual_palette_and_shade(struct blockset* blockset, u16 start, u16 len, struct color* destination);
 extern struct npc_palette* npc_palettes;
 extern volatile u8 tint_filter;
-void apply_shaders(u8 pal, u8 fade_copy, struct color* to_apply);
-struct color alpha_blend(struct color a, struct color b, u8 alpha);
 extern void blockset_load_palette_to_gpu(void* blockset, u16 start, u16 len);
-extern void gpu_pal_apply(struct color* src, u16 dst, u16 len);
 extern void load_palette_3(u16 start, u16 len);
 extern void tint_palette(u8 pal_slot);
 extern u8 gpu_pal_tags_index_of(u16 pal_tag);
 extern void lz77u_wram(void* src, void* dst);
 extern void* oe_read_word(void* oe_script_pointer);
 extern void some_weather_func(u8 pal_index);
-void copy_unfaded(u8 slot);
-void pal_patch_for_npc(u16 tag, u8 pal);
-u8 is_current_map_dn_valid(enum map_type current_type);
 //care, this has to be manually patched to be u16
 extern u16 npc_pal_idx_for_given_tag(u16 tag);
-struct color_shade get_color_from_time(enum time_type current_time);
-enum time_type get_time_of_day();
-void update_dns_palettes();
-void apply_lighting(void* blockset, u8 copy, struct color* to_apply);
+struct color_shade dns_get_shade_from_time(enum dns_rtc_time_type current_time);
+enum dns_rtc_time_type dns_get_time_of_day();
+void dns_update_palettes();
 
 extern void mapdata_load_palettes_to_gpu(struct mapdata_header* data_header);
-extern u16 npc_paltag_by_palslot(u8 slot);
 
 extern void script_something();
 extern void camera_update();

src/include/game_engine.h

@@ -36,6 +36,7 @@
 
 /* === INCLUDE === */
 #include <types.h>
+#include <battle_structs.h>
 
 /* === EXTERN METHODS === */
 
@@ -76,5 +77,12 @@ extern u32 pokemon_get_attribute(struct pokemon* poke_address, u8 request, void*
  */
 void pokemon_set_attribute(struct pokemon* poke_address, u8 request, void* new_value);
 
+/**
+ * @brief gets x12 value of item
+ * @param item_id item to get value of
+ * @return corresponding x12 value 
+ */
+extern u8 item_get_x12(u16 item_id);
+
 #endif /* GAME_ENGINE_H */
 

src/include/lcd.h

@@ -64,15 +64,6 @@ struct color {
     u16 b : 5;
 };
 
-/* === STATIC STRUCTURES === */
-
-static struct bg_config standard_bg[4] = {
-    {0, 0, 0x19, 0, 0, 0},
-    {1, 1, 0x1A, 0, 0, 1},
-    {2, 2, 0x1B, 0, 0, 2},
-    {3, 3, 0x1C, 0, 0, 3}
-};
-
 /* === EXTERN METHODS === */
 
 /**
@@ -131,6 +122,11 @@ extern void* virtual_bg_get_tilemap(u8 bg_id);
  */
 extern void virtual_bg_send_tilemap(u8 bg_id);
 
+/**
+ * @brief TODO DOCUMENT
+ */
+extern void gpu_pal_apply();
+
 
 /**
  * @brief decompress palette and copy to f/u buffers

src/include/memory.h

@@ -59,7 +59,7 @@ extern void free(void* address);
  * @param num amount of bytes to copy
  * @return destination pointer
  */
-extern void* memcpy (void * destination, const void* source, size_t num);
+extern void* memcpy(void * destination, const void* source, size_t num);
 
 /**
  * @brief set bytes in memory
@@ -68,7 +68,7 @@ extern void* memcpy (void * destination, const void* source, size_t num);
  * @param size number of bytes to set
  * @return 
  */
-extern void* memset (void* dst, int value, size_t size);
+extern void* memset(void* dst, int value, size_t size);
 
 /**
  * @brief decompress data into wram using interrupt

src/interface/lcd_io_test.S

@@ -37,7 +37,7 @@ get_flag_val:
 .global trans_activate
 trans_activate:
     push {r0-r7}
-    bl create_mugshot_on_variable
+    bl mug_create_on_variable
     bl get_flag_val
     cmp r0, #0
     bne no_activate
@@ -65,7 +65,7 @@ no_activate:
 .global trans_deactivate
 trans_deactivate:
     push {r0-r3}
-    bl delete_mugshot
+    bl mug_delete
     mov r0, #LCD_WIN_IN
     ldrh r1, =0x1F1F
     bl do_lcd_io_set

src/interface/textbox_mugshots.c

@@ -1,126 +1,180 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file textbox_mugshots.c
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Display little mugshot icons over the textbox
+ *
+ */
+
+/* === INCLUDES === */
 #include <objects.h>
 #include <callback.h>
 #include <config.h>
 #include <lcd.h>
-typedef struct mugshot {
-	void *gfx;
-	void *pal;
-} mugshot;
+#include <debug.h>
+#include <game_engine.h>
+#include <memory.h>
+
+/* === PROTOTYPES === */
+
+/**
+ * @brief null callback
+ * @param self object
+ */
+void mug_cb_null(struct obj_entity *self);
+
+/**
+ * @brief called when tb is opened to create mugshot
+ */
+void mug_create_on_variable();
+
+
+/**
+ * @brief called when tb is closed to delete mugshot
+ */
+void mug_delete();
+
+/* === STRUCTURES === */
+
+typedef struct mug_mugshot {
+    void *gfx;
+    void *pal;
+} mug_mugshot;
+
+/* TODO: USE GRIT AND ASM SYMBOL */
+
+/* === STATIC GLOBALS === */
+
+mug_mugshot *mugshots = (mug_mugshot(*)) 0x097007E0;
 
-//extern mugshot* mugshots;
-mugshot *mugshots = (mugshot (*) ) 0x097007E0;
 u8 *temp_obj_id1 = (u8*) OBJ_1_TEMP;
 u8 *temp_obj_id2 = (u8*) OBJ_2_TEMP;
-void* memset(void* ptr, int value, u32 num);
-
-u16* var_access(u16 num);
 
 struct obj_oam_attributes mug_sprite = {0, 0x8000, 0, 0};
 
-void null_callback(struct obj_entity *self);
-
-struct obj_template mugshot_1_template = {MUGSHOT_1_TAG, MUGSHOT_1_TAG, &mug_sprite, (struct obj_frame **)0x08231CF0, 0, (struct obj_rotscale_frame **)0x08231CFC, null_callback};
-struct obj_template mugshot_2_template = {MUGSHOT_2_TAG, MUGSHOT_2_TAG, &mug_sprite, (struct obj_frame **)0x08231CF0, 0, (struct obj_rotscale_frame **)0x08231CFC, null_callback};
-
-void create_mugshot_on_variable()
-{
-	u16 *mug1_var = var_access(MUGHSOT_1_TABLE);
-	u16 c_mug1_var = *mug1_var;
-	u16 mug_id_1 = c_mug1_var & 0x3FFF;
-	if(mug_id_1 != 0)
-	{
-		bool h_flip = (c_mug1_var & 0x8000) > 0;
-		bool v_flip = (c_mug1_var & 0x4000) > 0;
-		u16 *mug1_x = var_access(MUGSHOT_1_X);
-		u16 *mug1_y = var_access(MUGSHOT_1_Y);
-
-		mug_id_1--;
-		struct obj_resource gfx_mugshot_1 = {(mugshots[mug_id_1].gfx), 0x1C00, MUGSHOT_1_TAG};
-		struct obj_resource pal_mugshot_1 = {(mugshots[mug_id_1].pal), MUGSHOT_1_TAG};
-
-
-		obj_gpu_pal_alloc_tag_and_apply(&pal_mugshot_1);
-		obj_gpu_tile_decompress_alloc_tag_and_upload(&gfx_mugshot_1);
-
-		*temp_obj_id1 = (u16)obj_template_instanciate_forward_search(&mugshot_1_template, 0, 100, 1);
-
-		if(h_flip)
-			superstate.sprites[*temp_obj_id1].final_oam.attr1 |= 0x1000;
-		if(v_flip)
-			superstate.sprites[*temp_obj_id1].final_oam.attr1 |= 0x2000;
-
-		superstate.sprites[*temp_obj_id1].x = *mug1_x;
-		superstate.sprites[*temp_obj_id1].y = *mug1_y;
-	}
-	//return;
-	u16 *mug2_var = var_access(MUGHSOT_2_TABLE);
-	u16 c_mug2_var = *mug2_var;
-	u16 mug_id_2 = c_mug2_var & 0x3FFF;
-	if(mug_id_2 != 0)
-	{
-		bool h_flip = (c_mug2_var & 0x8000) > 0;
-		bool v_flip = (c_mug2_var & 0x4000) > 0;
-		u16 *mug2_x = var_access(MUGSHOT_2_X);
-		u16 *mug2_y = var_access(MUGSHOT_2_Y);
-
-		mug_id_2--;
-		struct obj_resource gfx_mugshot_2 = {(mugshots[mug_id_2].gfx), 0x1C00, MUGSHOT_2_TAG};
-		struct obj_resource pal_mugshot_2 = {(mugshots[mug_id_2].pal), MUGSHOT_2_TAG};
-
-
-		obj_gpu_pal_alloc_tag_and_apply(&pal_mugshot_2);
-		obj_gpu_tile_decompress_alloc_tag_and_upload(&gfx_mugshot_2);
-
-		c_mug2_var = *mug2_var;
-		*temp_obj_id2 = (u16)obj_template_instanciate_forward_search(&mugshot_2_template, 0, 100, 1);
-
-		if(h_flip)
-			superstate.sprites[*temp_obj_id2].final_oam.attr1 |= 0x1000;
-		if(v_flip)
-			superstate.sprites[*temp_obj_id2].final_oam.attr1 |= 0x2000;
-
-		superstate.sprites[*temp_obj_id2].x = *mug2_x;
-		superstate.sprites[*temp_obj_id2].y = *mug2_y;
-	}
+struct obj_template mugshot_1_template = {MUGSHOT_1_TAG, MUGSHOT_1_TAG, &mug_sprite, (struct obj_frame **) 0x08231CF0, 0, (struct obj_rotscale_frame **) 0x08231CFC, mug_cb_null};
+struct obj_template mugshot_2_template = {MUGSHOT_2_TAG, MUGSHOT_2_TAG, &mug_sprite, (struct obj_frame **) 0x08231CF0, 0, (struct obj_rotscale_frame **) 0x08231CFC, mug_cb_null};
+
+
+
+/* === IMPLEMENTATIONS === */
+
+void mug_create_on_variable() {
+    /* this is just some debug code! */
+    assert(NULL);
+
+    u16 *mug1_var = var_access(MUGHSOT_1_TABLE);
+    u16 c_mug1_var = *mug1_var;
+    u16 mug_id_1 = c_mug1_var & 0x3FFF;
+    if (mug_id_1 != 0) {
+        bool h_flip = (c_mug1_var & 0x8000) > 0;
+        bool v_flip = (c_mug1_var & 0x4000) > 0;
+        u16 *mug1_x = var_access(MUGSHOT_1_X);
+        u16 *mug1_y = var_access(MUGSHOT_1_Y);
+
+        mug_id_1--;
+        struct obj_resource gfx_mugshot_1 = {(mugshots[mug_id_1].gfx), 0x1C00, MUGSHOT_1_TAG};
+        struct obj_resource pal_mugshot_1 = {(mugshots[mug_id_1].pal), MUGSHOT_1_TAG};
+
+
+        obj_gpu_pal_alloc_tag_and_apply(&pal_mugshot_1);
+        obj_gpu_tile_decompress_alloc_tag_and_upload(&gfx_mugshot_1);
+
+        *temp_obj_id1 = (u16) obj_template_instanciate_forward_search(&mugshot_1_template, 0, 100, 1);
+
+        if (h_flip)
+            superstate.sprites[*temp_obj_id1].final_oam.attr1 |= 0x1000;
+        if (v_flip)
+            superstate.sprites[*temp_obj_id1].final_oam.attr1 |= 0x2000;
+
+        superstate.sprites[*temp_obj_id1].x = *mug1_x;
+        superstate.sprites[*temp_obj_id1].y = *mug1_y;
+    }
+    u16 *mug2_var = var_access(MUGHSOT_2_TABLE);
+    u16 c_mug2_var = *mug2_var;
+    u16 mug_id_2 = c_mug2_var & 0x3FFF;
+    if (mug_id_2 != 0) {
+        bool h_flip = (c_mug2_var & 0x8000) > 0;
+        bool v_flip = (c_mug2_var & 0x4000) > 0;
+        u16 *mug2_x = var_access(MUGSHOT_2_X);
+        u16 *mug2_y = var_access(MUGSHOT_2_Y);
+
+        mug_id_2--;
+        struct obj_resource gfx_mugshot_2 = {(mugshots[mug_id_2].gfx), 0x1C00, MUGSHOT_2_TAG};
+        struct obj_resource pal_mugshot_2 = {(mugshots[mug_id_2].pal), MUGSHOT_2_TAG};
+
+
+        obj_gpu_pal_alloc_tag_and_apply(&pal_mugshot_2);
+        obj_gpu_tile_decompress_alloc_tag_and_upload(&gfx_mugshot_2);
+
+        c_mug2_var = *mug2_var;
+        *temp_obj_id2 = (u16) obj_template_instanciate_forward_search(&mugshot_2_template, 0, 100, 1);
+
+        if (h_flip)
+            superstate.sprites[*temp_obj_id2].final_oam.attr1 |= 0x1000;
+        if (v_flip)
+            superstate.sprites[*temp_obj_id2].final_oam.attr1 |= 0x2000;
+
+        superstate.sprites[*temp_obj_id2].x = *mug2_x;
+        superstate.sprites[*temp_obj_id2].y = *mug2_y;
+    }
 }
 
-void delete_mugshot()
-{
-	u16 *mug1_var = var_access(MUGHSOT_1_TABLE);
-	u16 *mug2_var = var_access(MUGHSOT_2_TABLE);
+void mug_delete() {
+    //u16 *mug1_var = var_access(MUGHSOT_1_TABLE);
+    //u16 *mug2_var = var_access(MUGHSOT_2_TABLE);
 
-	if(*temp_obj_id1 != 0)
-	{
-		gpu_pal_free_by_tag(MUGSHOT_1_TAG);
-		obj_gpu_tile_free_by_tag(MUGSHOT_1_TAG);
+    if (*temp_obj_id1 != 0) {
+        gpu_pal_free_by_tag(MUGSHOT_1_TAG);
+        obj_gpu_tile_free_by_tag(MUGSHOT_1_TAG);
 
-		//*mug1_var = 0;
-		//do reset mugshot var ; set it to old value instead
+        //*mug1_var = 0;
+        //do reset mugshot var ; set it to old value instead
 
-		//*mug1_var = objects[object_id_1].private[0];
+        //*mug1_var = objects[object_id_1].private[0];
 
-		obj_delete_and_free_tiles(&(superstate.sprites[*temp_obj_id1]));
-		*temp_obj_id1 = 0;
-	}
+        obj_delete_and_free_tiles(&(superstate.sprites[*temp_obj_id1]));
+        *temp_obj_id1 = 0;
+    }
 
-	//return;
-	if(*temp_obj_id2 != 0)
-	{
-		gpu_pal_free_by_tag(MUGSHOT_2_TAG);
-		obj_gpu_tile_free_by_tag(MUGSHOT_2_TAG);
+    //return;
+    if (*temp_obj_id2 != 0) {
+        gpu_pal_free_by_tag(MUGSHOT_2_TAG);
+        obj_gpu_tile_free_by_tag(MUGSHOT_2_TAG);
 
-		//*mug2_var = 0;
-		//do reset mugshot var ; set it to old value instead
+        //*mug2_var = 0;
+        //do reset mugshot var ; set it to old value instead
 
-		//*mug2_var = objects[object_id_2].private[0];
+        //*mug2_var = objects[object_id_2].private[0];
 
-		obj_delete_and_free_tiles(&(superstate.sprites[*temp_obj_id2]));
-		*temp_obj_id2 = 0;
-	}
+        obj_delete_and_free_tiles(&(superstate.sprites[*temp_obj_id2]));
+        *temp_obj_id2 = 0;
+    }
 
 }
 
-void null_callback(struct obj_entity *self)
-{
-	//null_callback
+void mug_cb_null(struct obj_entity *self) {
+    return;
 }

src/interface/trans_mug_close_fix.S

@@ -33,5 +33,5 @@ sub_08069B34:
 .align 2
 trans_deactivate_2:
 	push {lr}
-	bl delete_mugshot
+	bl mug_delete
 	pop {pc}

src/moves/ability_changers/ability_change.c

@@ -1,4 +1,8 @@
-#include <battle.h>
+#include <battle_locations.h>
+#include <types.h>
+#include <battle_structs.h>
+#include <pkmn_abilities.h>
+#include <moves.h>
 
 extern void* str_worry_seed_ref;
 extern void* str_entrainment_ref;
@@ -102,5 +106,7 @@ u8 ability_change() {
             return role_play();
         case MOVE_SKILL_SWAP:
             return skill_swap();
+        default:
+            return false;
     }
 }

src/moves/assurance/assurance.c

@@ -1,6 +1,7 @@
-#include <battle.h>
+#include <battle_locations.h>
+#include <battle_structs.h>
 
-u8 assurance_damage_modifier()
+void assurance_damage_modifier()
 {
     if((battle_protect[battle_defender_bank].physical_damage + battle_protect[battle_defender_bank].special_damage) > 0)
         battle_damage_multiplier *=2;

src/moves/bride/bride.c

@@ -1,5 +1,5 @@
-#include <battle.h>
-
+#include <battle_structs.h>
+#include <battle_locations.h>
 u8 bride_has_multiplier()
 {
     if(battle_participants[battle_defender_bank].current_hp <= battle_participants[battle_defender_bank].max_hp >> 1)

src/moves/close_combat/close_combat.c

@@ -1,4 +1,6 @@
-#include <battle.h>
+#include <battle_locations.h>
+#include <battle_structs.h>
+#include <types.h>
 
 extern void* bs_cc_lower_def;
 extern void* bs_cc_lower_sdef;

src/moves/crush_grip_like/hp_damage_mod.c

@@ -1,4 +1,5 @@
-#include <battle.h>
+#include <battle_structs.h>
+#include <battle_locations.h>
 
 u8 hp_damage_mod()
 {

src/moves/defog/defog.c

@@ -1,4 +1,7 @@
-#include <battle.h>
+#include <battle_locations.h>
+#include <battle_structs.h>
+#include <battle_common.h>
+#include <battle_custom_structs.h>
 
 u8 defog_field()
 {

src/moves/feint/feint.c

@@ -1,9 +1,11 @@
-#include <battle.h>
+#include <battle_structs.h>
+#include <battle_locations.h>
+#include <battle_custom_structs.h>
+#include <battle_common.h>
 
 extern void* bs_feint_no_break_ptr;
 
 u8 break_shields() {
-    u8 side = get_side_from_bank(battle_defender_bank);
     u8 effect = false;
     struct bank_affecting* defender_bank = &custom_battle_elements.ptr->bank_affecting[battle_defender_bank];
     struct side_affecting* defender_side = &custom_battle_elements.ptr->side_affecting[get_side_from_bank(battle_defender_bank)];
@@ -38,4 +40,5 @@ u8 break_shields() {
     if(effect)
         return false;
     battlescript_cursor = bs_feint_no_break_ptr;
+    return true;
 }

src/moves/gastro_acid/gastro_acid.c

@@ -1,4 +1,6 @@
-#include <battle.h>
+#include <battle_locations.h>
+#include <battle_structs.h>
+#include <battle_custom_structs.h>
 
 u8 gastro_acid_set() {
     if (custom_battle_elements.ptr->bank_affecting[battle_defender_bank].gastro_acided) {

src/moves/healing_wish/healing_wish.c

@@ -1,8 +1,11 @@
-#include <battle.h>
+#include <battle_common.h>
 #include <battle_help.h>
+#include <battle_locations.h>
+#include <battle_custom_structs.h>
+#include <battle_structs.h>
 
 u8 set_healing_wish() {
-    if (count_party_pokemon(battle_attacker_bank) <= 1) {
+    if (battle_count_party_pokemon(battle_attacker_bank) <= 1) {
         //it will fail
         battlescript_cursor = (void*) (0x081D7DF0);
         return true;

src/moves/lucky_chant/lucky_chant.c

@@ -1,4 +1,7 @@
-#include <battle.h>
+#include <battle_locations.h>
+#include <battle_common.h>
+#include <battle_custom_structs.h>
+#include <battle_structs.h>
 
 u8 lucky_chant_set()
 {

src/moves/magnet_rise/magnet_rise.c

@@ -1,4 +1,7 @@
-#include <battle.h>
+#include <battle_common.h>
+#include <battle_locations.h>
+#include <battle_custom_structs.h>
+#include <battle_structs.h>
 
 u8 set_magnet_rise() {
     struct bank_affecting* user = &custom_battle_elements.ptr->bank_affecting[battle_attacker_bank];

src/moves/metal_burst/metal_burst.c

@@ -1,4 +1,5 @@
-#include <battle.h>
+#include <battle_locations.h>
+#include <types.h>
 
 u8 metal_burst_dmg_reduction()
 {

src/moves/pay_back/pay_back.c

@@ -1,4 +1,4 @@
-#include <battle.h>
+#include <battle_locations.h>
 
 u8 pay_back_damage_modifier()
 {

src/moves/power_trick/power_trick.c

@@ -1,5 +1,6 @@
-#include <battle.h>
-#include <bpre.h>
+#include <battle_structs.h>
+#include <battle_locations.h>
+#include <battle_custom_structs.h>
 
 u8 power_trick_swap() 
 {

src/moves/punishment/punishment.c

@@ -1,4 +1,5 @@
-#include <battle.h>
+#include <battle_structs.h>
+#include <battle_locations.h>
 
 u8 punishment_damage_mod() {
     struct battle_participant* defender = &battle_participants[battle_defender_bank];

src/moves/rooms/rooms.c

@@ -1,4 +1,8 @@
-#include <battle.h>
+#include <battle_common.h>
+#include <moves.h>
+#include <battle_custom_structs.h>
+#include <battle_structs.h>
+#include <battle_locations.h>
 
 extern void* str_trick_room_off_ref;
 extern void* str_trick_room_on_ref;

src/moves/roost/roost.c

@@ -1,5 +1,6 @@
 #include <battle_structs.h>
-#include <battle.h>
+#include <pkmn_types.h>
+#include <battle_locations.h>
 
 u8 roost_change_type()
 {

src/moves/split_moves/split_moves.c

@@ -1,4 +1,6 @@
-#include <battle.h>
+#include <battle_locations.h>
+#include <battle_structs.h>
+#include <moves.h>
 
 extern void* str_guard_split_ref;
 extern void* str_power_split_ref;

src/moves/swap_moves/swap_moves.c

@@ -1,4 +1,7 @@
-#include <battle.h>
+#include <battle_common.h>
+#include <moves.h>
+#include <battle_structs.h>
+#include <battle_locations.h>
 
 extern void* str_power_swap_ref;
 extern void* str_guard_swap_ref;

src/moves/tailwind/tailwind.c

@@ -1,4 +1,7 @@
-#include <battle.h>
+#include <battle_locations.h>
+#include <battle_structs.h>
+#include <battle_custom_structs.h>
+#include <battle_common.h>
 
 extern void* bs_tailwind_failed_ptr;
 

src/moves/veno_shock/venoshock_has_multiplier.c

@@ -1,4 +1,5 @@
-#include <battle.h>
+#include <battle_locations.h>
+#include <battle_structs.h>
 
 u8 venoshock_has_multiplier()
 {

src/music/music_override.c

@@ -1,7 +1,47 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file music_override.c
+ * @author ipatix
+ * @date 15 dec 2016
+ * @brief Play some custom music
+ * 
+ */
+
+/* === INCLUDES === */
+
 #include <sound.h>
 #include <game_engine.h>
 #include <config.h>
 
+/* === PROTTYPES === */
+/**
+ * @brief overrides a music routine to load music ids from a custom variable
+ * @param songid song_id to be overridden
+ */
+void music_override(u16 songid);
+
+/* === IMPLEMENTATIONS === */
 void music_override(u16 songid) {
     int skip = 0;
     if (flag_check(FLAG_ENABLE_MUSIC_OVERRIDES)) {

src/overworld/overworld.c

@@ -1,9 +1,42 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file overworld.c
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Routines to work with the new overworld npc table
+ * 
+ */
+
+/* === INCLUDES === */
 #include <game_engine.h>
 
+/* === DEFINES === */
 #define OW_REPLACE_VAR  0x500A
 #define OW_REPLACE_TO_VAR   0x500B
 
-struct coords16{
+/* === STRUCTURES === */
+struct ow_point{
     u16 x;
     u16 y;
 };
@@ -13,7 +46,7 @@ struct npc_type {
     u16 pal_num;
     u16 pal_tag_2;
     u16 field_6;
-    struct coords16 pos_neg_center;
+    struct ow_point pos_neg_center;
     u8 pal_slot_unk;
     u8 field_D;
     u16 pal_table;
@@ -24,15 +57,25 @@ struct npc_type {
     u32 rot_scale_anims;
 };
 
-extern struct npc_type* ow_main_table;
-extern struct npc_type* ow_second_table;
-extern struct npc_type* ow_third_table;
-
+/* === PROTOTYPES === */
+/**
+ * @brief get the npc type struct by given 16 bit npc id
+ * @param npc_id short npc id
+ * @return pointer to corresponding npc_type structure
+ */
+struct npc_type* npc_get_type(u16 npc_id);
 
+/* === EXTERN STATICS ===*/
+struct npc_type** ow_main_table;
+struct npc_type** ow_second_table;
+struct npc_type** ow_third_table;
 
+/* === IMPLEMENTATIONS === */
 struct npc_type* npc_get_type(u16 npc_id)
 {
-    struct npc_type** npc_tables[] = {ow_main_table, ow_second_table, ow_third_table};
+    /* Not possible in a global scope because of gcc cow magic */
+    struct npc_type** npc_tables[3] = {ow_main_table, ow_second_table, ow_third_table};
+    //struct npc_type** npc_tables[] = {ow_main_table, ow_second_table, ow_third_table};
     u16* replace_ow = var_access(OW_REPLACE_VAR);
     if(*replace_ow > 0 && *replace_ow - 1 == npc_id)
     {

src/specials/camera_move.c

@@ -1,17 +1,69 @@
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file camera_move.c
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Scene to update the camera
+ * 
+ * This provides implementations to move the game camera
+ */
+
+/* === INCLUDES === */
+
 #include <game_engine.h>
 #include "camera_move.h"
 #include <callback.h>
 #include <fade.h>
 #include <config.h>
+#include <lcd.h>
+
+/* === PROTOTYPES === */
+
+/**
+ * @brief special to handle the camera update scene
+ */
+void cam_cb_move_camera();
 
-struct point** sav_data_map = (struct point**)(0x03005008);
+/**
+ * @brief vblank screen update method for the camera scene
+ */
+void cam_update_screen();
 
-struct point {
+/* === STRUCTURES === */
+
+struct cam_point {
   u16 x;
   u16 y;
 };
 
-void update_screen_cam()
+/* === STATIC STRUCTURES === */
+
+struct cam_point** sav_data_map = (struct cam_point**)(0x03005008);
+
+/* === IMPLEMENTATIONS === */
+
+void cam_update_screen()
 {
 	fade_update();
 	task_exec();
@@ -21,14 +73,14 @@ void update_screen_cam()
 	obj_gpu_sprites_upload();
 }
 
-void sp_move_camera()
+void cam_sp_move_camera()
 {
-  set_callback2(sp_move_camera_callback);
+  set_callback2(cam_cb_move_camera);
   fade_screen(0xFFFFFFFF, 0, 0, 0x10, 0x0000);
-  vblank_handler_set(update_screen_cam);
+  vblank_handler_set(cam_update_screen);
 }
 
-void sp_move_camera_callback()
+void cam_cb_move_camera()
 {
     if((fade_controller.mix_color & 0x8000) == 0)
     {

src/specials/camera_move.h

@@ -1,3 +1,43 @@
-void camera_move_and_redraw(int x, int y);
-void sp_move_camera();
-void sp_move_camera_callback();
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file camera_move.h
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Scene to update the camera
+ * 
+ * This provides prototypes to move the game camera
+ */
+
+#ifndef CAMERA_MOVE_H_
+#define CAMERA_MOVE_H_
+
+/* === PROTOTYPES === */
+
+/**
+ * @brief move camera to position specified in CAMERA_VAR_X and CAMERA_VAR_Y
+ */
+void cam_sp_move_camera();
+
+
+#endif

src/specials/custom_specials.c

@@ -1,16 +1,80 @@
-#include <bpre.h>
+/****************************************************************************
+ * Copyright (C) 2015-2016 by the SotS Team                                 *
+ *                                                                          *
+ * This file is part of Sovereign of the Skies.                             *
+ *                                                                          *
+ *   Sovereign of the Skies is free software: you can redistribute it       *
+ *   and/or modify it                                                       *
+ *   under the terms of the GNU Lesser General Public License as published  *
+ *   by the Free Software Foundation, either version 3 of the License, or   *
+ *   (at your option) any later version provided you include a copy of the  *
+ *   licence and this header.                                               *
+ *                                                                          *
+ *   Sovereign of the Skies is distributed in the hope that it will be      *
+ *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
+ *   GNU Lesser General Public License for more details.                    *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with Sovereign of the Skies.                             *
+ *   If not, see <http://www.gnu.org/licenses/>.                            *
+ ****************************************************************************/
+
+/**
+ * @file custom_specials.c
+ * @author Sturmvogel
+ * @date 15 dec 2016
+ * @brief Special 0x68 implementation to read from LASTRESULT and execute
+ * 
+ */
+
+/* === INCLUDES === */
+
 #include "cutscene_meteor.h"
 #include "camera_move.h"
+#include <callback.h>
 #include <debug.h>
+#include <game_engine.h>
+#include <config.h>
+
+/* === PROTOTYPES === */
+
+/**
+ * @brief test routine to switch dns
+ */
+void sp_dns_switch();
+
+/**
+ * @brief clear some flags at the beginning of the game
+ */
+void sp_init_script();
+
+
+/**
+ * @brief callasm to call a var-based routine as defined
+ */
+void sp_special_casm();
+
+/* === STATICS === */
 
-void dns_switch()
+static callback special_routines[5] = {
+    met_play,
+    cam_sp_move_camera,
+    sp_init_script,
+    debug_some_test,
+    sp_dns_switch,
+};
+
+/* === IMPLEMENTATIONS === */
+
+void sp_dns_switch()
 {
     volatile u8* test_pointer = (u8*) (0x0203FAB0);
     *(test_pointer+1) = (*(test_pointer+1) == 3 ? 0 : (*(test_pointer+1)) + 1);
     *test_pointer = 1;
 }
 
-void init_script()
+void sp_init_script()
 {
   for(u16 i = 0x1000; i < 0x1800; ++i)
   {
@@ -18,17 +82,8 @@ void init_script()
   }
 }
 
-static callback special_routines[5] = {
-	met_play,
-	sp_move_camera,
-	init_script,
-        debug_some_test,
-        dns_switch,
-};
-
-
-void special_asm() //special 0x68
+void sp_special_casm() //special 0x68
 {
-	u16* var_special = var_access(CALLASM_VAR);
-	special_routines[*var_special]();
+    u16* var_special = var_access(CALLASM_VAR);
+    special_routines[*var_special]();
 }

src/specials/cutscene_meteor.c

@@ -74,6 +74,15 @@ struct meteor_memory{
 	u16 delay_end;
 };
 
+/* === STATIC STRUCTURES === */
+
+static struct bg_config met_bg_config[4] = {
+    {0, 0, 0x19, 0, 0, 0},
+    {1, 1, 0x1A, 0, 0, 1},
+    {2, 2, 0x1B, 0, 0, 2},
+    {3, 3, 0x1C, 0, 0, 3}
+};
+
 /* === PROTOTYPES === */
 
 /**
@@ -274,7 +283,7 @@ void met_setup_vram()
 	gpu_tile_bg_drop_all_sets(2);
 	gpu_tile_bg_drop_all_sets(3);
 
-	gpu_bg_vram_setup(0, standard_bg, 4);
+	gpu_bg_vram_setup(0, met_bg_config, 4);
 
 	gpu_bg_show(0);
 	gpu_bg_show(1);

string/de/item_data.txt

@@ -1,4 +1,4 @@
-@include <item_effects.h>
+@include <pkmn_item_effects.h>
 
 @string_len=14