react-native-asset-generator
v1.0.29
Published
open source package to automatize React Native asset generation on Android and IOS
Downloads
43
Readme
React Native Assets Generator
React Native Icon Generator is a tool designed to simplify and speed up the process of generating all necessary app icon assets for both Android and iOS platforms using a single source image. This tool is intended to streamline the asset generation process, allowing developers to focus more on building features and less on manually creating app icons.
Features
✅ Completed Features
- Generate Android Assets:
- Automatically generate all required Android icon assets (mdpi, hdpi, xhdpi, xxhdpi, xxxhdpi) from a single image file.
- Generate iOS Assets:
- Automatically generate all required iOS icon assets for various device resolutions and sizes within the
AppIcon.appiconset
folder.
- Automatically generate all required iOS icon assets for various device resolutions and sizes within the
- Custom Path Selection/Input for Android and iOS:
- Allow users to specify custom output directories for generated Android and iOS assets.
🚧 Planned Features
- Support for Android Rounded Icons:
- Option to generate Android rounded icons for devices that support adaptive icons.
🤔 Why not Features
- Generate Splash Screens:
- Add support for generating splash screen assets for both Android and iOS platforms.
- Web Platform Support:
- Extend the generator to create assets for web applications (e.g., favicons, manifest icons).
Installation
To install the package, use npm or yarn:
npm install react-native-asset-generator
or
yarn add react-native-asset-generator
Usage
Basic Usage
Generate Android and iOS Icons:
node ./path/to/your/generator --input ./path/to/image.png --output ./output/directory
This command will generate all the necessary Android and iOS icons in the specified output directory.
Example
import { Generator } from "react-native-asset-generator";
const generator = new Generator("./path/to/input.png", "./path/to/output");
generator.generate();
Contributing
We welcome contributions! Please submit a pull request or open an issue to discuss the feature you'd like to add or the bug you'd like to fix.
Development Setup
- Clone the repository:
git clone https://github.com/yourusername/react-native-asset-generator.git
- Install dependencies:
npm install
- Run tests:
npm test
License
This project is licensed under the MIT License - see the LICENSE file for details.
Roadmap
We are constantly improving the tool. Below is our short-term roadmap:
- [ ] Add custom path selection for Android and iOS assets.
- [ ] Support for rounded icons on Android.
- [ ] Add a command-line interface (CLI) with more customization options.
- [ ] Implement web platform support.
- [ ] Extend support to generate splash screen assets for both platforms.
Acknowledgements
This tool was inspired by the need for a fast and automated way to generate app icons for multiple platforms in React Native projects. We hope it helps the community as much as it has helped us.