Skip to content

Commit

Permalink
Update copyright
Browse files Browse the repository at this point in the history
Need to add my name to the copyright for various legal reasons/issues. This does not change anything in the project, just a formality.
  • Loading branch information
rodlie committed Oct 11, 2024
1 parent bd5548c commit 5d4afd8
Show file tree
Hide file tree
Showing 873 changed files with 980 additions and 979 deletions.
106 changes: 106 additions & 0 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# Build Friction

Generic instructions for building Friction on supported systems.

## Requirements on Linux

* pkg-config
* ninja
* python3
* cmake *(3.12+)*
* clang *(7+)*
* Qt *(5.15.x)*
* Gui
* Widgets
* OpenGL
* Multimedia
* Qml
* Xml
* qscintilla
* ffmpeg *(4.2.x)*
* libavformat
* libavcodec
* libavutil
* libswscale
* libswresample
* libunwind
* expat
* harfbuzz
* freetype
* fontconfig
* libjpeg-turbo
* libpng
* libwebp
* zlib
* icu

## Requirements on Windows

* [Visual Studio 2017 Build Tools](https://aka.ms/vs/15/release/vs_buildtools.exe)
* `git` must be available in `PATH`
* `cmake` must be available in `PATH`
* `python3` must be available in `PATH`
* [LLVM](https://github.com/llvm/llvm-project/releases/download/llvmorg-15.0.7/LLVM-15.0.7-win64.exe) installed to default location
* Qt 5.15.14 libraries and headers in `friction\sdk`
* See [configure_qt5.bat](src/scripts/configure_qt5.bat) and [build_qt5.bat](src/scripts/build_qt5.bat)
* QScintilla 2.14.1 libraries and headers in `friction\sdk`
* See [build_qscintilla.bat](src/scripts/build_qscintilla.bat)
* FFmpeg 4.2.9 libraries and headers in `friction\sdk`
* See [build_mxe_ffmpeg.sh](src/scripts/build_mxe_ffmpeg.sh) and [mxe](https://github.com/friction2d/mxe)

Binary SDK available [here](https://github.com/friction2d/friction-sdk/releases).

## Get Source

```
git clone --recurse-submodules https://github.com/friction2d/friction
```

or

```
git clone --recurse-submodules https://codeberg.org/friction/friction
```

## Build on Linux

```
mkdir build
cd build
cmake -G Ninja \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=/usr \
-DCMAKE_CXX_COMPILER=clang++ \
-DCMAKE_C_COMPILER=clang \
..
```
Note that on some configurations you may need to specify `qscintilla` paths:
```
-DQSCINTILLA_INCLUDE_DIRS=<PATH_TO_QSCINTILLA_INCLUDE_DIR> \
-DQSCINTILLA_LIBRARIES_DIRS=<PATH_TO_LIBS> \
-DQSCINTILLA_LIBRARIES=<QSCINTILLA_LIBRARY_NAME> \
```

Now build:

```
cmake --build . --config Release
```

## Build on Windows

All requirements must be installed in the correct folders, this is an example and should be adjusted to fit your environment.

```
call "C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\Common7\Tools\VsDevCmd.bat"
set SDK_DIR=%cd%\sdk
set PATH=C:\Python;%ProgramFiles%\CMake\bin;%ProgramFiles%\Git\bin;%SDK_DIR%\bin;%PATH%
mkdir build
cd build
cmake -G "Visual Studio 15 2017" -A x64 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=%SDK_DIR% ..
cmake --build . --config Release
```
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
111 changes: 3 additions & 108 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,117 +28,12 @@ A new stable branch is cut from `main` on each `X` or `Y` release and is maintai

Important fixes added to `main` will be backported to active stable branches when possible (and within reason).

## Build

Generic build instructions.

### Requirements on Linux

* pkg-config
* ninja
* python3
* cmake *(3.12+)*
* clang *(7+)*
* Qt *(5.15.x)*
* Gui
* Widgets
* OpenGL
* Multimedia
* Qml
* Xml
* qscintilla
* ffmpeg *(4.2.x)*
* libavformat
* libavcodec
* libavutil
* libswscale
* libswresample
* libunwind
* expat
* harfbuzz
* freetype
* fontconfig
* libjpeg-turbo
* libpng
* libwebp
* zlib
* icu

### Requirements on Windows

* [Visual Studio 2017 Build Tools](https://aka.ms/vs/15/release/vs_buildtools.exe)
* `git` must be available in `PATH`
* `cmake` must be available in `PATH`
* `python3` must be available in `PATH`
* [LLVM](https://github.com/llvm/llvm-project/releases/download/llvmorg-15.0.7/LLVM-15.0.7-win64.exe) installed to default location
* Qt 5.15.14 libraries and headers in `friction\sdk`
* See [configure_qt5.bat](src/scripts/configure_qt5.bat) and [build_qt5.bat](src/scripts/build_qt5.bat)
* QScintilla 2.14.1 libraries and headers in `friction\sdk`
* See [build_qscintilla.bat](src/scripts/build_qscintilla.bat)
* FFmpeg 4.2.9 libraries and headers in `friction\sdk`
* See [build_mxe_ffmpeg.sh](src/scripts/build_mxe_ffmpeg.sh) and [mxe](https://github.com/friction2d/mxe)

Binary SDK available [here](https://github.com/friction2d/friction-sdk/releases).

### Get Source

```
git clone --recurse-submodules https://github.com/friction2d/friction
```

or

```
git clone --recurse-submodules https://codeberg.org/friction/friction
```

### Build on Linux

```
mkdir build
cd build
cmake -G Ninja \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX=/usr \
-DCMAKE_CXX_COMPILER=clang++ \
-DCMAKE_C_COMPILER=clang \
..
```
Note that on some configurations you may need to specify `qscintilla` paths:
```
-DQSCINTILLA_INCLUDE_DIRS=<PATH_TO_QSCINTILLA_INCLUDE_DIR> \
-DQSCINTILLA_LIBRARIES_DIRS=<PATH_TO_LIBS> \
-DQSCINTILLA_LIBRARIES=<QSCINTILLA_LIBRARY_NAME> \
```

Now build:

```
cmake --build . --config Release
```

### Build on Windows

All requirements must be installed in the correct folders, this is an example and should be adjusted to fit your environment.

```
call "C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\Common7\Tools\VsDevCmd.bat"
set SDK_DIR=%cd%\sdk
set PATH=C:\Python;%ProgramFiles%\CMake\bin;%ProgramFiles%\Git\bin;%SDK_DIR%\bin;%PATH%
mkdir build
cd build
cmake -G "Visual Studio 15 2017" -A x64 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=%SDK_DIR% ..
cmake --build . --config Release
```

## License

Copyright &copy; Friction contributors.
Friction is copyright &copy; Ole-André Rodlie and contributors.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

**This program 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 General Public License](LICENSE.md) for more details.**

Friction is based on [enve](https://github.com/MaurycyLiebner/enve) - Copyright &copy; Maurycy Liebner and contributors.
2 changes: 1 addition & 1 deletion src/app/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/BoxesList/boolpropertywidget.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/BoxesList/boolpropertywidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/BoxesList/boxscrollarea.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/BoxesList/boxscrollarea.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/BoxesList/boxscroller.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/BoxesList/boxscroller.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/BoxesList/boxscrollwidget.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/BoxesList/boxscrollwidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/BoxesList/boxsinglewidget.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/BoxesList/boxsinglewidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/BoxesList/boxtargetwidget.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/BoxesList/boxtargetwidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/Dialogs/animationtopaintdialog.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/Dialogs/animationtopaintdialog.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/Dialogs/dialogsinterfaceimpl.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/Dialogs/dialogsinterfaceimpl.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
2 changes: 1 addition & 1 deletion src/app/GUI/Expressions/expressiondialog.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# Friction - https://friction.graphics
#
# Copyright (c) Friction contributors
# Copyright (c) Ole-André Rodlie and contributors
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down
Loading

0 comments on commit 5d4afd8

Please sign in to comment.