Skip to content

Commit e0958d2

Browse files
Alvarwow69Alvarwow69
authored
Merge pull request #3 from Creative-Rift/develop
Release 1.0
2 parents 9ad263e + 8febf55 commit e0958d2

File tree

23 files changed

+964
-1
lines changed

23 files changed

+964
-1
lines changed

‎.github/workflows/Test_windows.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: SWPacker Windows
2+
on:
3+
push:
4+
branches:
5+
- main
6+
- develop
7+
pull_request:
8+
branches:
9+
- main
10+
- develop
11+
workflow_dispatch:
12+
13+
env:
14+
BUILD_TYPE: Release
15+
16+
jobs:
17+
Test_windows:
18+
runs-on: windows-latest
19+
steps:
20+
- name: Checkout repository
21+
uses: actions/checkout@v2
22+
23+
- name: Config executables
24+
run: |
25+
mkdir build && cd build
26+
cmake -B ${{github.workspace}}\build -G "Visual Studio 17 2022" -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} ..
27+
28+
- name: Build executables
29+
run: |
30+
cd ${{github.workspace}}\build
31+
cmake --build ${{github.workspace}}\build --config ${{env.BUILD_TYPE}}
32+
33+
- name: Archive Executable
34+
uses: actions/upload-artifact@v3
35+
with:
36+
name: SWPacker
37+
path: ${{github.workspace}}\out\0.1\Release\

‎CMakeLists.txt‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## CMAKE VAR
2+
## <=====================================>
3+
cmake_minimum_required( VERSION 3.17...3.22 )
4+
set( CMAKE_CXX_STANDARD 20 )
5+
set( CMAKE_CXX_STANDARD_REQUIRED True )
6+
set( CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/out/ )
7+
set( CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/out/ )
8+
set( CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/out/ )
9+
## <=====================================>
10+
11+
project( "SW Packer"
12+
VERSION
13+
1.0
14+
DESCRIPTION
15+
"Pack all resources into one file"
16+
LANGUAGES
17+
CXX
18+
)
19+
20+
set( CMAKE_CXX_STANDARD 20 )
21+
set( CMAKE_CXX_STANDARD_REQUIRED True )
22+
set( CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/out/${CMAKE_PROJECT_VERSION} )
23+
set( CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/out/${CMAKE_PROJECT_VERSION} )
24+
set( CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/out/${CMAKE_PROJECT_VERSION} )
25+
set(PREFIX_MESSAGE "[${PROJECT_NAME}] ")
26+
27+
## <=====================================>
28+
29+
message(${PREFIX_MESSAGE} "Build type set to: " ${CMAKE_BUILD_TYPE})
30+
message(${PREFIX_MESSAGE} "Current cmake location: " ${CMAKE_CURRENT_SOURCE_DIR})
31+
message(${PREFIX_MESSAGE} "Project location: " ${CMAKE_SOURCE_DIR})
32+
message(${PREFIX_MESSAGE} "Project system: " ${CMAKE_SYSTEM_NAME})
33+
34+
35+
include(cmake/Packer.cmake)
36+
include(cmake/UnPacker.cmake)

‎README.md‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,29 @@
1-
# packer
1+
# SWPacker
2+
## Description
3+
SWPacker is program that allow to pack all files from a directory.
4+
It builds a single file `.swfp` with all resources inside.
5+
6+
## Compilation
7+
The compilation is simple, you can choose between two target: Packer and Unpacker.
8+
```shell
9+
mkdir "build" && cd build
10+
cmake -G "Visual Studio 17 2022" - DCMAKE_BUILD_TYPE=[Debug/Release] ..
11+
cmake --build . --target SWEngine-[packer/unpacker]_0.1 --config [Debug/Release]
12+
```
13+
14+
## Usage
15+
### Packer
16+
Simply run the executable and give the directory you want to pack.
17+
```shell
18+
./SWEngine-packer_0.1 [PATH_TO_DIRECTORY]
19+
```
20+
21+
### UnPacker
22+
Simply run the executable and give the directory where the file `.swfp` file is.
23+
```shell
24+
./SWEngine-unpacker_0.1 [PATH_TO_SWFP_FILE]
25+
```
26+
27+
## Authors
28+
The project is made by [Guillaume Soisson](https://github.com/Alvarwow69). \
29+
This project is based on raysan5 works for [rres](https://github.com/raysan5/rres)

‎cmake/Packer.cmake‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
## PROJECT VAR
2+
## <=====================================>
3+
set( EXEC "SWEngine-packer_${CMAKE_PROJECT_VERSION}" )
4+
set( EXT cpp )
5+
## <=====================================>
6+
7+
## SOURCE FOLDERS
8+
set( SRC_FOLDERS
9+
${CMAKE_CURRENT_SOURCE_DIR}/sources/
10+
${CMAKE_CURRENT_SOURCE_DIR}/sources/file/
11+
${CMAKE_CURRENT_SOURCE_DIR}/sources/pack/
12+
${CMAKE_CURRENT_SOURCE_DIR}/sources/log/
13+
${CMAKE_CURRENT_SOURCE_DIR}/sources/exception/
14+
${CMAKE_CURRENT_SOURCE_DIR}/sources/utils/
15+
)
16+
## INCLUDE FOLDERS
17+
set( INC_FOLDERS
18+
${CMAKE_CURRENT_SOURCE_DIR}/includes/
19+
${CMAKE_CURRENT_SOURCE_DIR}/includes/file/
20+
${CMAKE_CURRENT_SOURCE_DIR}/includes/pack/
21+
${CMAKE_CURRENT_SOURCE_DIR}/includes/log/
22+
${CMAKE_CURRENT_SOURCE_DIR}/includes/exception/
23+
)
24+
25+
## GET SOURCES
26+
## <=====================================>
27+
set(TMP "")
28+
foreach(filePath ${SRC_FOLDERS})
29+
string(APPEND TMP "${filePath}*.${EXT};")
30+
endforeach()
31+
file(GLOB SRC ${TMP})
32+
## <=====================================>
33+
34+
35+
## OUTPUT
36+
## <=====================================>
37+
## EXECUTABLE
38+
add_executable(${EXEC} ${SRC})
39+
## <=====================================>
40+
41+
target_compile_definitions(${EXEC} PUBLIC "SWFP_PACKER")
42+
43+
44+
## ADD INCLUDES
45+
## <=====================================>
46+
target_include_directories(${EXEC} PUBLIC ${INC_FOLDERS})
47+
## <=====================================>
48+
49+
## ADD PARAMETER
50+
## <=====================================>
51+
if(MSVC)
52+
target_compile_options(${EXEC} PRIVATE "/MP")
53+
endif()
54+
## <=====================================>
55+
56+
if (${CMAKE_BUILD_TYPE} MATCHES Debug)
57+
set_target_properties(${EXEC} PROPERTIES
58+
DEBUG_POSTFIX "d")
59+
endif()

‎cmake/UnPacker.cmake‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
## PROJECT VAR
2+
## <=====================================>
3+
set( EXEC "SWEngine-unpacker_${CMAKE_PROJECT_VERSION}" )
4+
set( EXT cpp )
5+
## <=====================================>
6+
7+
## SOURCE FOLDERS
8+
set( SRC_FOLDERS
9+
${CMAKE_CURRENT_SOURCE_DIR}/sources/
10+
${CMAKE_CURRENT_SOURCE_DIR}/sources/file/
11+
${CMAKE_CURRENT_SOURCE_DIR}/sources/unpack/
12+
${CMAKE_CURRENT_SOURCE_DIR}/sources/exception/
13+
${CMAKE_CURRENT_SOURCE_DIR}/sources/utils/
14+
${CMAKE_CURRENT_SOURCE_DIR}/sources/log/
15+
)
16+
## INCLUDE FOLDERS
17+
set( INC_FOLDERS
18+
${CMAKE_CURRENT_SOURCE_DIR}/includes/
19+
${CMAKE_CURRENT_SOURCE_DIR}/includes/file/
20+
${CMAKE_CURRENT_SOURCE_DIR}/includes/unpack/
21+
${CMAKE_CURRENT_SOURCE_DIR}/includes/exception/
22+
${CMAKE_CURRENT_SOURCE_DIR}/includes/log/
23+
)
24+
25+
## GET SOURCES
26+
## <=====================================>
27+
set(TMP "")
28+
foreach(filePath ${SRC_FOLDERS})
29+
string(APPEND TMP "${filePath}*.${EXT};")
30+
endforeach()
31+
file(GLOB SRC ${TMP})
32+
## <=====================================>
33+
34+
35+
## OUTPUT
36+
## <=====================================>
37+
## EXECUTABLE
38+
add_executable(${EXEC} ${SRC})
39+
## <=====================================>
40+
41+
target_compile_definitions(${EXEC} PUBLIC "SWFP_UNPACKER")
42+
43+
## ADD INCLUDES
44+
## <=====================================>
45+
target_include_directories(${EXEC} PUBLIC ${INC_FOLDERS})
46+
## <=====================================>
47+
48+
## ADD PARAMETER
49+
## <=====================================>
50+
if(MSVC)
51+
target_compile_options(${EXEC} PRIVATE "/MP")
52+
endif()
53+
## <=====================================>
54+
55+
if (${CMAKE_BUILD_TYPE} MATCHES Debug)
56+
set_target_properties(${EXEC} PROPERTIES
57+
DEBUG_POSTFIX "d")
58+
endif()

‎includes/csc32.hpp‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
/*
2+
** SWPacker , 2023
3+
** csc.hpp
4+
*/
5+
6+
#ifndef SW_PACKER_CSC_HPP
7+
#define SW_PACKER_CSC_HPP
8+
9+
#include <string>
10+
11+
namespace sw
12+
{
13+
/// \brief Generate a CSC32 from the given buffer
14+
///
15+
/// \param buffer - unsigned char *
16+
/// \param size - unsigned int
17+
/// \return unsigned int
18+
unsigned int computeCsc32(unsigned char *buffer, unsigned int size);
19+
20+
static unsigned int crcTable[256] = {
21+
0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419, 0x706AF48F, 0xE963A535, 0x9E6495A3,
22+
0x0eDB8832, 0x79DCB8A4, 0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07, 0x90BF1D91,
23+
0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE, 0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7,
24+
0x136C9856, 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC, 0x14015C4F, 0x63066CD9, 0xFA0F3D63, 0x8D080DF5,
25+
0x3B6E20C8, 0x4C69105E, 0xD56041E4, 0xA2677172, 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B,
26+
0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940, 0x32D86CE3, 0x45DF5C75, 0xDCD60DCF, 0xABD13D59,
27+
0x26D930AC, 0x51DE003A, 0xC8D75180, 0xBFD06116, 0x21B4F4B5, 0x56B3C423, 0xCFBA9599, 0xB8BDA50F,
28+
0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924, 0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D,
29+
0x76DC4190, 0x01DB7106, 0x98D220BC, 0xEFD5102A, 0x71B18589, 0x06B6B51F, 0x9FBFE4A5, 0xE8B8D433,
30+
0x7807C9A2, 0x0F00F934, 0x9609A88E, 0xE10E9818, 0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01,
31+
0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E, 0x6C0695ED, 0x1B01A57B, 0x8208F4C1, 0xF50FC457,
32+
0x65B0D9C6, 0x12B7E950, 0x8BBEB8EA, 0xFCB9887C, 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3, 0xFBD44C65,
33+
0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2, 0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB,
34+
0x4369E96A, 0x346ED9FC, 0xAD678846, 0xDA60B8D0, 0x44042D73, 0x33031DE5, 0xAA0A4C5F, 0xDD0D7CC9,
35+
0x5005713C, 0x270241AA, 0xBE0B1010, 0xC90C2086, 0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F,
36+
0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, 0x59B33D17, 0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD,
37+
0xEDB88320, 0x9ABFB3B6, 0x03B6E20C, 0x74B1D29A, 0xEAD54739, 0x9DD277AF, 0x04DB2615, 0x73DC1683,
38+
0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8, 0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1,
39+
0xF00F9344, 0x8708A3D2, 0x1E01F268, 0x6906C2FE, 0xF762575D, 0x806567CB, 0x196C3671, 0x6E6B06E7,
40+
0xFED41B76, 0x89D32BE0, 0x10DA7A5A, 0x67DD4ACC, 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5,
41+
0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, 0xD1BB67F1, 0xA6BC5767, 0x3FB506DD, 0x48B2364B,
42+
0xD80D2BDA, 0xAF0A1B4C, 0x36034AF6, 0x41047A60, 0xDF60EFC3, 0xA867DF55, 0x316E8EEF, 0x4669BE79,
43+
0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236, 0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F,
44+
0xC5BA3BBE, 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, 0xC2D7FFA7, 0xB5D0CF31, 0x2CD99E8B, 0x5BDEAE1D,
45+
0x9B64C2B0, 0xEC63F226, 0x756AA39C, 0x026D930A, 0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713,
46+
0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38, 0x92D28E9B, 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21,
47+
0x86D3D2D4, 0xF1D4E242, 0x68DDB3F8, 0x1FDA836E, 0x81BE16CD, 0xF6B9265B, 0x6FB077E1, 0x18B74777,
48+
0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C, 0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45,
49+
0xA00AE278, 0xD70DD2EE, 0x4E048354, 0x3903B3C2, 0xA7672661, 0xD06016F7, 0x4969474D, 0x3E6E77DB,
50+
0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, 0x37D83BF0, 0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9,
51+
0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, 0xBAD03605, 0xCDD70693, 0x54DE5729, 0x23D967BF,
52+
0xB3667A2E, 0xC4614AB8, 0x5D681B02, 0x2A6F2B94, 0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B, 0x2D02EF8D
53+
};
54+
}
55+
56+
#endif //SW_PACKER_CSC_HPP

‎includes/exception/FileException.hpp‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
** ShipWreck Engine , 2023
3+
** FileException.hpp
4+
*/
5+
6+
#ifndef SW_PACKER_FILEEXCEPTION_HPP
7+
#define SW_PACKER_FILEEXCEPTION_HPP
8+
9+
#include <exception>
10+
#include <string>
11+
12+
namespace sw
13+
{
14+
class FileException : public std::exception
15+
{
16+
private:
17+
std::string m_reason;
18+
public:
19+
explicit FileException(std::string&& reason);
20+
[[nodiscard]] const char *what() const override;
21+
};
22+
}
23+
24+
#endif //SW_PACKER_FILEEXCEPTION_HPP

‎includes/exception/MemoryException.hpp‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/*
2+
** ShipWreck Engine , 2023
3+
** MemoryException.hpp
4+
*/
5+
6+
#ifndef SW_PACKER_MEMORYEXCEPTION_HPP
7+
#define SW_PACKER_MEMORYEXCEPTION_HPP
8+
9+
#include <exception>
10+
#include <string>
11+
12+
namespace sw {
13+
14+
class MemoryException : public std::exception
15+
{
16+
private:
17+
std::string m_message;
18+
public:
19+
explicit MemoryException(std::string message);
20+
[[nodiscard]]const char * what() const override;
21+
};
22+
23+
} // sw
24+
25+
#endif //SW_PACKER_MEMORYEXCEPTION_HPP

‎includes/file/Chunk.hpp‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
/*
2+
** SWPacker , 2023
3+
** ChunkHeader.hpp
4+
*/
5+
6+
#ifndef SW_PACKER_CHUNK_HPP
7+
#define SW_PACKER_CHUNK_HPP
8+
9+
namespace sw
10+
{
11+
/// \brief Define all data type supported. Few for now
12+
/// but will add more later
13+
enum resourceDataType {
14+
DATA_NULL = 0,
15+
DATA_RAW = 1,
16+
};
17+
18+
/// \brief Define all data in the header for a single chunk.
19+
/// \b comp and \b nextOffset will be added later
20+
struct chunkHeader {
21+
unsigned char type[4]; // chunk type
22+
unsigned int id; // chunk identifier
23+
//unsigned char comp; // compression algorithm
24+
unsigned int sizePack; // compressed size
25+
unsigned int sizeBase; // base size
26+
//unsigned int nextOffset; // next resource chunk
27+
unsigned int crc32; // data crc32
28+
};
29+
30+
/// \brief Define all data needed un a chunk.
31+
/// \b Props is useless a the moment but useful later
32+
/// \b Path is useful only for a DEVPACK
33+
struct chunkData {
34+
unsigned int propsCount; // Number of props uin the chunk
35+
unsigned int pathCount; // Length of the path
36+
unsigned int *props; // List of props
37+
char *path; // Path
38+
void *data; // Raw data
39+
};
40+
41+
/// \brief Structure for a chunk, composed of one header and one data
42+
struct resourceChunk {
43+
chunkHeader header;
44+
chunkData data;
45+
};
46+
}
47+
48+
#endif //SW_PACKER_CHUNK_HPP

0 commit comments

Comments
 (0)