Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/YunYouJun/cocos-creator-joystick

🕹 Cocos Creator Joystick Demo 虚拟摇杆
https://github.com/YunYouJun/cocos-creator-joystick

cocos-creator demo input-handler joystick

Last synced: 16 days ago
JSON representation

🕹 Cocos Creator Joystick Demo 虚拟摇杆

Host: GitHub
URL: https://github.com/YunYouJun/cocos-creator-joystick
Owner: YunYouJun
License: mit
Created: 2019-04-04T11:10:22.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2021-03-07T16:36:22.000Z (over 3 years ago)
Last Synced: 2024-04-14T01:03:13.198Z (7 months ago)
Topics: cocos-creator, demo, input-handler, joystick
Language: TypeScript
Homepage: https://yunyoujun.github.io/cocos-creator-joystick/
Size: 2.55 MB
Stars: 228
Watchers: 6
Forks: 89
Open Issues: 2
Metadata Files:
- Readme: README.en.md
- License: LICENSE

Awesome Lists containing this project

awesome - YunYouJun/cocos-creator-joystick - 🕹 Cocos Creator Joystick Demo 虚拟摇杆 (TypeScript)
awesome - YunYouJun/cocos-creator-joystick - 🕹 Cocos Creator Joystick Demo 虚拟摇杆 (TypeScript)

README

        # cocos-creator-joystick

> Cocos Creator Joystick Demo

- [Version 0.2.0](https://github.com/YunYouJun/cocos-creator-joystick/releases/tag/v0.2.0) for Cocos Creator 3.0

- [Version 0.1.0](https://github.com/YunYouJun/cocos-creator-joystick/releases/tag/v0.1.0) for TypeScript (Cocos Creator 2.x)

- [Version 0.0.2](https://github.com/YunYouJun/cocos-creator-joystick/releases/tag/v0.0.2) for JavaScript (Cocos Creator 2.x)

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/YunYouJun/cocos-creator-joystick?style=social)](https://github.com/YunYouJun/cocos-creator-joystick/releases)

[![Cocos Creator version](https://img.shields.io/badge/Cocos_Creator-v3.x-blue.svg?style=social&logo=cocos)](https://www.cocos.com/creator)

![GitHub top language](https://img.shields.io/github/languages/top/YunYouJun/cocos-creator-joystick.svg?style=social&logo=typescript)

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/YunYouJun/cocos-creator-joystick.svg?style=social&logo=visual-studio-code)

[中文文档](./README.md) | English Docs

Online Preview: [cocos-creator-joystick](https://yunyoujun.github.io/cocos-creator-joystick)

## Usage

### Downoload

[Releases](https://github.com/YunYouJun/cocos-creator-joystick/releases)

### By import

> Cocos Creator v3.x -> File -> Export assets ... -> Choose -> assets/demo.fire

> Cocos Creator v3.x -> File -> Import assets ...

### By git

```sh

git clone https://github.com/YunYouJun/cocos-creator-joystick.git

```

Open with `Cocos Creator 3.x`.

You can see it in `demo.fire` scene.

> Go through the main menu Developer -> VS Code Workflow -> Update VS Code API Source to complete the update about `creator.d.ts`.

## Function

- Joystick Type

  - [x] Fixed

  - [x] Follow

- Player

  - [x] rotation

  - [x] move

- Touch Place (custom Joystick width and height)

  - [x] Full Screen

  - [x] Half Screen

- Decoupling between nodes (only need to monitor Touch events, without mounting the Player node to Joystick, can control many Players)

### Joystick

| Argument     | Type                                     | Default            | Description              | Customizable |

| ------------ | ---------------------------------------- | ------------------ | ------------------------ | ------------ |

| joystickType | JoystickType.FIXED / JoystickType.FOLLOW | JoystickType.FIXED | types of joystick        | √            |

| ring         | cc.Node                                  | -                  | joystick background node | √            |

| dot          | cc.Node                                  | -                  | joystick control node    | √            |

### Player

| Argument    | Type                                               | Default                    | Description                   | Controled by Joystick | Customizable |

| ----------- | -------------------------------------------------- | -------------------------- | ----------------------------- | --------------------- | ------------ |

| rigidbody   | boolean                                            | false                      | Rigidbody (Physics) mode      | ×                     | x            |

| moveDir     | Vec2                                               | cc.v2(0, 1) // straight up | initial direction of movement | √                     | √            |

| \_speedType | SpeedType.STOP / SpeedType.NORMAL / SpeedType.FAST | SpeedType.NORMAL           | speed type                    | √                     | ×            |

| \_moveSpeed | cc.Integer                                         | 0                          | speed of movement             | ×                     | ×            |

| stopSpeed   | cc.Integer                                         | 0                          | speed when stop               | ×                     | √            |

| normalSpeed | cc.Integer                                         | 100                        | normal speed                  | ×                     | √            |

| fastSpeed   | cc.Integer                                         | 200                        | fast speed                    | ×                     | √            |

## Structure

> assets/script

| Filename    | Description     | Function                                                                                                     |

| ----------- | --------------- | ------------------------------------------------------------------------------------------------------------ |

| Joystick.js | Joystick Script | store joystick main logic (include some type definitions and global events listen)                           |

| Player.js   | Player Script   | listen events emitted by Joystick (You can customize it.)                                                    |

| UI.js       | UI              | provide switch joystick type function for online preview（You can delete it directly if you don't need it.） |

## Other

Star, [`Issues`](https://github.com/YunYouJun/cocos-creator-joystick/issues) and `Pull requests` are welcome.

[Recommended coding standards](https://docs.cocos.com/creator/manual/en/scripting/reference/coding-standards.html)

## Dev

### Build

```sh

npm run build

```

### Deploy

```sh

npm run deploy

```