Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
blackspotbear committed Oct 8, 2024
0 parents commit 9f105ac
Show file tree
Hide file tree
Showing 49 changed files with 19,949 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .clang-format
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
BasedOnStyle: LLVM
IndentWidth: 4
TabWidth: 4
AccessModifierOffset: -4
UseTab: Always
BreakBeforeBraces: Allman
ColumnLimit: 140

DerivePointerAlignment: false
PointerAlignment: Left

BinPackArguments: false
BinPackParameters: false

ConstructorInitializerAllOnOneLineOrOnePerLine : true
BreakConstructorInitializersBeforeComma : true
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
/build_asmjs/
/build_wasm/
/Release/*
!/Release/effekseer.d.ts
!/Release/package.json
!/Release/package-lock.json
!/Release/akashic-lib.json
!/Release/tsconfig.json
!/Release/typedoc.json
!/Release/Sample/
venv/

4 changes: 4 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[submodule "Effekseer"]
path = Effekseer
url = https://github.com/effekseer/Effekseer.git

5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# ChangeLog

## 1.0.0

最初のリリース。
1 change: 1 addition & 0 deletions Effekseer
Submodule Effekseer added at 92fdeb
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2024 DWANGO Co., Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
20 changes: 20 additions & 0 deletions LICENSE-Effekseer
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
The MIT License (MIT)

Copyright (c) 2011 Effekseer Project

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
75 changes: 75 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<p align="center">
<img src="https://raw.githubusercontent.com/akashic-games/effekseer-for-akashic-engine/main/img/akashic.png" />
</p>

# Effekseer for Akashic Engine

Effekseer for Akashic Engine は [EffekseerForWebGL](https://github.com/effekseer/EffekseerForWebGL)[Akashic Engine](https://akashic-games.github.io/) 向けポートです。 [Effekseer 1.7e](https://github.com/effekseer/Effekseer/releases/tag/170e) を利用します。

## 利用方法

[akashic-cli](https://github.com/akashic-games/akashic-cli) でインストールします。

```sh
akashic install @akashic-extension/effekseer-for-akashic-engine
```

コンテンツからは、

```javascript
const ea = require("@akashic-extension/effekseer-for-akashic-engine");
```

で利用してください。

[Akashic Engine](https://akashic-games.github.io/) の詳細な利用方法については、 [公式ページ](https://akashic-games.github.io/) を参照してください。

## サンプル

`Release/Sample` ディレクトリにサンプルが用意されています。詳細はサンプルの `README.md` を参照してください。

## APIリファレンス

[こちら](https://akashic-games.github.io/effekseer-for-akashic-engine/api/index.html)

## ビルド方法

### 事前準備

Effekseer for Akashic Engine のビルドには git, python, cmake, emscripten そして node.js が必要です。それぞれの公式サイトにある手順に従ってインストールしてください。Window環境では [MinGW](https://winlibs.com/) もインストールしてください。Emscripten はバージョン 3.1.60 で確認しています。一部 Emscripten の出力するソースコードを書き換えているため、他のバージョンでの動作は確認していません。

- [MinGW](https://winlibs.com/) (Windows 環境のみ)
- 解凍後 mingw32/bin または mingw64/bin を PATH 環境変数に加える
- [Git \- Downloads](https://git-scm.com/downloads)
- [Download Python \| Python\.org](https://www.python.org/downloads/)
- [Download CMake](https://cmake.org/download/)
- [Download and install — Emscripten 3\.1\.61\-git \(dev\) documentation](https://emscripten.org/docs/getting_started/downloads.html)
- [Node\.js — Download Node\.js®](https://nodejs.org/en/download/package-manager)

git submodule を利用しています。リポジトリをクローンした後、初期化します。

```sh
git clone https://github.com/akashic-games/effekseer-for-akashic-engine
cd effekseer-for-akashic-engine
git submodule update --init # Effekseer をサブモジュールとして導入
```

build.py に必要なパッケージをインストールします。以下の手順ではグローバル環境にインストールします。必要に応じて [venv](https://docs.python.org/ja/3/library/venv.html) などで作成した仮想環境を利用してください。

```sh
python -m pip install -r requirements.txt
```

### ビルド

```sh
python build.py # Effekseer を Wasm 形式にビルド
```

## ライセンス

オリジナルの EffekseerForWebGL は MIT License の元で公開されています。[LICENE-Effekseer](./LICENSE-Effekseer)をご覧ください。

Akashic Engine 向けの変更および追加は同じく MIT License の元で公開されています。[LICENSE](./LICENSE) をご覧ください。

ただし、画像ファイルおよび音声ファイルは [CC BY 2.1 JP](https://creativecommons.org/licenses/by/2.1/jp/) の元で公開されています。また、サンプルで使用している Effekseer のエフェクトは [Effekseer 公式サイト](https://effekseer.github.io/jp/contribute.html)で配布されているもので、[CC-0](http://creativecommons.org/about/cc0) ライセンスで公開されています。
18 changes: 18 additions & 0 deletions Release/Sample/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

[*.ts]
indent_size = 4
indent_style = tab

[game.json]
indent_size = 4
indent_style = tab
insert_final_newline = false
191 changes: 191 additions & 0 deletions Release/Sample/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
module.exports = {
"root": true,
"env": {
"browser": true,
"es6": true
},
"parser": "@typescript-eslint/parser",
"parserOptions": {
"project": "tsconfig.json",
"sourceType": "module"
},
"plugins": [
"@typescript-eslint",
"import"
],
"ignorePatterns": [
"**/*.js"
],
"rules": {
"@typescript-eslint/naming-convention": [
"error",
{
"selector": "default",
"format": ["camelCase"],
"leadingUnderscore": "allow"
},
{
"selector": "class",
"format": ["PascalCase"]
},
{
"selector": "interface",
"format": ["PascalCase"]
},
{
"selector": "typeAlias",
"format": ["PascalCase"]
},
{
"selector": "property",
"format": null
}
],
"@typescript-eslint/indent": [
"error",
"tab",
{
"FunctionDeclaration": {
"parameters": "first"
},
"FunctionExpression": {
"parameters": "first"
},
"SwitchCase": 1,
"flatTernaryExpressions": true,
"ignoredNodes": ["ConditionalExpression"]
}
],
"@typescript-eslint/interface-name-prefix": "off",
"@typescript-eslint/member-delimiter-style": [
"error",
{
"multiline": {
"delimiter": "semi",
"requireLast": true
},
"singleline": {
"delimiter": "semi",
"requireLast": false
},
"overrides": {
"interface": {
"singleline": {
"delimiter": "semi",
"requireLast": true
},
"multiline": {
"delimiter": "semi",
"requireLast": true
}
}
}
}
],
"@typescript-eslint/member-ordering": ["error",
{
"default": [
"public-static-field",
"public-instance-field",
"private-instance-field",
"public-static-method",
"public-constructor",
"public-instance-method",
"private-instance-method"
]
}
],
"@typescript-eslint/no-empty-function": "error",
"@typescript-eslint/no-parameter-properties": "error",
"@typescript-eslint/no-var-requires": "error",
"@typescript-eslint/quotes": [
"error",
"double"
],
"@typescript-eslint/semi": [
"error"
],
"@typescript-eslint/type-annotation-spacing": "error",
"@typescript-eslint/typedef": ["error", {
"propertyDeclaration": true,
"memberVariableDeclaration": false,
"parameter": true,
"arrowParameter": false
}],
"@typescript-eslint/explicit-function-return-type": ["error", {
"allowExpressions": true,
"allowTypedFunctionExpressions": true
}],
"@typescript-eslint/no-unused-vars": ["error", {
"vars": "all",
"args": "none",
"argsIgnorePattern": "^_"
}],
"camelcase": "off",
"curly": "off",
"dot-notation": "error",
"eol-last": "error",
"eqeqeq": [
"error",
"smart"
],
"guard-for-in": "error",
"id-blacklist": "off",
"id-match": "off",
"max-len": [
"error",
{
"code": 140
}
],
"no-bitwise": "off",
"no-caller": "error",
"no-console": [
"error",
{
"allow": [
"log",
"warn",
"dir",
"timeLog",
"assert",
"clear",
"count",
"countReset",
"group",
"groupEnd",
"table",
"dirxml",
"error",
"groupCollapsed",
"Console",
"profile",
"profileEnd",
"timeStamp",
"context"
]
}
],
"no-debugger": "error",
"no-empty": "error",
"no-eval": "error",
"no-fallthrough": "error",
"no-new-wrappers": "error",
"no-redeclare": "off",
"no-trailing-spaces": "error",
"comma-spacing": "error",
"brace-style": "error",
"no-underscore-dangle": "off",
"no-unused-expressions": "error",
"no-unused-labels": "error",
"radix": "error",
"spaced-comment": ["error", "always", { "markers": ["/"] }],
"keyword-spacing": ["error"],
"import/order": ["error", {
"alphabetize": {
"order": "asc",
"caseInsensitive": true
}
}]
}
}
6 changes: 6 additions & 0 deletions Release/Sample/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
node_modules/
script/
game/
coverage
game.zip

Loading

0 comments on commit 9f105ac

Please sign in to comment.