# Cosplay

This is the design repository for NorCal Hakkero Factory No. 1, where we use
parametric CAD to make cosplay props. We design cosplay props based on an
engineering point of view.

> NorCal Hakkero Factory № 1
>
> 北加国営八卦炉第一工場

Most cosplay schematics are created with Blender, CadQuery, and Inkscape.

## Development

Install `uv`, and then execute

``` sh
uv sync
```

To get a development environment, run
``` sh
uv venv
```

Then, either follow the instruction to activate this venv, or install `direnv`
and create the file

``` sh
# .envrc
source .venv/bin/activate
```

Test the environment with `python3 -c "import nhf"`

To visualize an object, create a file `visualize.py`, and run `cq-editor`:

``` sh
python3 -m cq_editor visualize.py
```

### Folder Structure

- `nhf/parts/`: Ready-made parts
- `nhf/$WORK/$CHARACTER`: Design for an individual character

For each individual character, the `__init__.py` script stores the overall build
entry point and the entry point for all unit tests.

### Testing

Run all tests with
``` sh
unittest-parallel
```

## Troubleshooting

### Wayland

If there is the error
```
X Error of failed request:  BadWindow (invalid Window parameter)
  Major opcode of failed request:  3 (X_GetWindowAttributes)
  Resource id in failed request:  0x3
  Serial number of failed request:  28
  Current serial number in output stream:  29
```
Export the environment variable

``` sh
export QT_QPA_PLATFORM=xcb
```