pygame-assets 0.1

[](https://travis-ci.org/florimondmanca/pygame-assets)

# Pygame Assets

PygameAssets是一个轻量级的Pygame应用程序和游戏的资产管理器，设计为可插拔、可扩展和可配置。

## 安装

[进行中] Pygame Assets将很快可在PyPI上使用，因此您将能够使用`pip`安装它

```bash
$ pip install pygame-assets
```

## 文档

完整文档托管在[ReadTheDocs](#)。

## 入门

PygameAssets期望您的资产位于名为`assets`的文件夹中，该文件夹应位于您的游戏项目目录的根目录中。让我们创建此文件夹

```sh
my_project $ mkdir assets/
```

想加载名为`player.png`的图像吗？

1. 将`player.png`拖放到`assets/image`
2. 在您的游戏中加载图像
```python

import pygame
import pygame_assets as assets

# 确保设置_mode()
screen = pygame.display.set_mode((800, 600))

player_img = assets.load.image('player.png')
```

太棒了！ :tada

奖金积分：PygameAssets 负责所有模板代码，这意味着 `assets.load.image` 会自动调用 `convert_alpha()` 对您的图像进行转换（如果需要的话）。


## 这是魔法吗？

事实上，PygameAssets 的 API 大部分都归结为 `pygame_assets.load` 对象，该对象提供了对 PygameAssets 的 **加载器** 的访问。

使用加载器的通用语法如下

```python
asset = pygame_assets.load.<loader_name>(filename, ...)
```

每个加载器都期望在 `assets/<loader_name>` 中找到资产。这就是为什么我们之前将 `player.png` 放入 `assets/image` 的原因。

### 内置加载器

PygameAssets 内置以下加载器：`image`、`image_with_rect`、`sound`、`music`、`font`、`freetype`。

请参阅文档以获取每个加载器的完整 API 参考。

## 自定义配置！

### 自定义加载器

如果您需要，PygameAssets 允许您轻松定义自己的资产加载器。自定义加载器的定义基于 `pygame_assets.loaders.loader` 装饰器。以下是使用方法：

```python
# my_project/custom_loaders.py
from pygame_assets.loaders import loader

@loader()
def spritesheet(filepath)
# 加载精灵表并返回它
```

现在我们可以使用我们的自定义加载器来加载精灵表（位于 `assets/spritesheet`）

```python
# my_project/game.py
import pygame_assets as assets

walking_player = assets.load.spritesheet('player-walk.png')
```

您可以在 [文档](#documentation) 中查看自定义加载器 API。

### 自定义配置

PygameAssets 可以轻松地集成到任何项目中，多亏了它明智的默认设置。然而，这些默认设置可能并不总是符合您的需求。

PygameAssets 允许您设置一些自定义配置

```python
import pygame_assets as assets

# 重新定义资产基本目录的名称（默认为 'assets'）
assets.config.base = 'static'

# 您可以为任何已注册的加载器注册其他搜索目录。
assets.config.dirs['spritesheet'].append('sheets')
# => PygameAssets 现在也会在 'static/sheets' 中寻找精灵表。

# 默认情况下，PygameAssets 在本地 `asset_loaders` 模块中寻找自定义加载器。
# 您也可以重新定义该模块的路径。
assets.config.custom_loaders_location = 'src.path.to.my.loaders.module'
```